はじめに
対話型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. Configuring BotKit API

Configuring BotKit API

To configuring the Botkit Url, App, and events.

To use this API, app needs the Bot Builder API scope of BotKit.

PUT https://{{host}}/api/public/bot/{{BotID}}/sdkSubscription

Query Parameters

Parameter Description
host Environment URL, for example, https://bots.kore.ai
BotID Bot ID or Stream ID. You can access it from the General Settings page of the bot.

Body Parameters

Parameter Description
connectorEnabled To enable connector (optional)
PIIMaskingDisabledForAgentTransfer To disable PII masking (optional).
sdkClientId Client Id to be associated with the SDK bot kit
sdkHostUri SDK host URL
subscribedFor array of events that need to be subscribed for

Authorization

Invoke the API with JWT in the header with the following syntax:

auth: {{JWT}}

Response Content Type

application/json

Sample Request

curl -X PUT \
   https://{{host}}/api/bot/{{BotID}}/sdkSubscription' \  
  -H 'auth: {{YOUR_JWT_ACCESS_TOKEN}}' \
  -d '{
       "connectorEnabled": false, // optional
       "PIIMaskingDisabledForAgentTransfer": false, //optional
       "sdkClientId": "cs-xxxxx-xxxx-xxxx-xxxx-xxxxx",
       "sdkHostUri": "https://example.ngrok.io",
       "subscribedFor": [             
	   "onMessage",
	   "onHook",
	   "onEvent",
	   "onAlert",
	   "onVariableUpdate"
	]}'

 

Sample Response

<Bot info object>

Configuring BotKit API

To configuring the Botkit Url, App, and events.

To use this API, app needs the Bot Builder API scope of BotKit.

PUT https://{{host}}/api/public/bot/{{BotID}}/sdkSubscription

Query Parameters

Parameter Description
host Environment URL, for example, https://bots.kore.ai
BotID Bot ID or Stream ID. You can access it from the General Settings page of the bot.

Body Parameters

Parameter Description
connectorEnabled To enable connector (optional)
PIIMaskingDisabledForAgentTransfer To disable PII masking (optional).
sdkClientId Client Id to be associated with the SDK bot kit
sdkHostUri SDK host URL
subscribedFor array of events that need to be subscribed for

Authorization

Invoke the API with JWT in the header with the following syntax:

auth: {{JWT}}

Response Content Type

application/json

Sample Request

curl -X PUT \
   https://{{host}}/api/bot/{{BotID}}/sdkSubscription' \  
  -H 'auth: {{YOUR_JWT_ACCESS_TOKEN}}' \
  -d '{
       "connectorEnabled": false, // optional
       "PIIMaskingDisabledForAgentTransfer": false, //optional
       "sdkClientId": "cs-xxxxx-xxxx-xxxx-xxxx-xxxxx",
       "sdkHostUri": "https://example.ngrok.io",
       "subscribedFor": [             
	   "onMessage",
	   "onHook",
	   "onEvent",
	   "onAlert",
	   "onVariableUpdate"
	]}'

 

Sample Response

<Bot info object>
メニュー