ウィジェット設定

KnoAskのチャットボットを自社のWebサイトに設置する方法を説明します。コピー&ペーストするだけで、簡単に設置できます。

準備:ボットトークンの取得

ウィジェットを設置するには、まずボットの公開トークン(Bot Token)を取得する必要があります。

  1. KnoAskにログイン
    KnoAskにログインして、ダッシュボードを開きます。
  2. ボットを選択
    設置したいボットを選択し、ボット詳細画面を開きます。
  3. 埋め込みコードをコピー
    ボット詳細画面の「埋め込み」セクションで、表示されている埋め込みコードをコピーします。 このコードには、ボットトークン(`data-bot-token`)が含まれています。

💡 ヒント
ボットトークンは、ボットごとに自動生成される一意の文字列です。セキュリティのため、トークンは他人に共有しないでください。

方法1: HTMLへの直接埋め込み(推奨)

最も簡単な方法です。HTMLファイルに1行のコードを追加するだけで設置できます。

基本的な設置方法

HTMLの``タグの閉じタグの直前に、以下のコードを追加してください:

<script src="https://app.knoask.com/widget.js" data-bot-token="YOUR_BOT_TOKEN" data-api-url="https://app.knoask.com" data-theme="light" data-mode="floating" data-position="bottom-right"> </script>

完全なHTML例

<!DOCTYPE html> <html lang="ja"> <head> <meta charset="UTF-8"> <title>My Website</title> </head> <body> <h1>Welcome to My Website</h1> <p>This is my website content.</p> <!-- KnoAsk Widget --> <script src="https://app.knoask.com/widget.js" data-bot-token="YOUR_BOT_TOKEN" data-api-url="https://app.knoask.com" data-theme="light" data-mode="floating" data-position="bottom-right"> </script> </body> </html>

設定オプション

属性 必須 説明 デフォルト値
src 必須 ウィジェットJavaScriptファイルのURL -
data-bot-token 必須 ボットの公開トークン(ボット詳細画面で取得) -
data-api-url オプション APIのベースURL 現在のドメイン
data-theme オプション テーマ(light または dark light
data-position オプション ウィジェットの位置(bottom-right または bottom-leftdata-mode="floating"時のみ有効) bottom-right
data-mode オプション 表示モード(floating または inline floating
data-inline-target オプション インライン表示時の描画先セレクタ(例: #knoask-inline-chat 未指定時はscript直前
data-inline-height オプション インライン表示時のチャット欄の高さ(例: 640px, 70vh 640px

テーマのカスタマイズ

data-theme属性で、ウィジェットのテーマを変更できます:

  • light: ライトテーマ(白背景、推奨)
  • dark: ダークテーマ(黒背景)

位置のカスタマイズ

data-position属性で、ウィジェットの表示位置を変更できます:

  • bottom-right: 画面右下(デフォルト)
  • bottom-left: 画面左下

インライン埋め込み(社内ポータル向け)

社内FAQのように「常時表示のチャット欄」が必要な場合は、data-mode="inline"を指定してください。右下アイコンではなく、指定した要素内にチャット欄を表示します。

<div id="knoask-inline-chat"></div> <script src="https://app.knoask.com/widget.js" data-bot-token="YOUR_BOT_TOKEN" data-api-url="https://app.knoask.com" data-theme="light" data-mode="inline" data-inline-target="#knoask-inline-chat" data-inline-height="640px"> </script>
  • data-inline-targetで指定した要素が存在しない場合は、scriptタグ直前に自動挿入して表示されます。
  • data-inline-heightpx/vh/vw/rem/em/%が利用できます。

方法2: WordPressプラグインを使用

WordPressを使用している場合は、専用のプラグインを使用することで、より簡単に設置できます。

プラグインのインストール

  1. プラグインをダウンロード
    KnoAsk WordPressプラグインをダウンロードします。
  2. WordPressにアップロード
    WordPress管理画面の「プラグイン」>「新規追加」>「プラグインのアップロード」から、プラグインファイルをアップロードします。
  3. プラグインを有効化
    アップロード後、「プラグインを有効化」をクリックします。
  4. 設定を行う
    「KnoAsk」>「設定」で、API URLとAPIキー(Bearerトークン)を設定します。表示するボットはショートコードのbot_idで指定します。

ショートコードの使用

プラグインをインストールすると、以下のショートコードが使用できます:

[knoask_chat bot_id="1" position="bottom-right"]

このショートコードを、ページや投稿に追加するだけで、チャットボットが表示されます。

📝 注意
利用前に、プラグイン同梱のREADME/INSTALLATIONに記載の要件(WordPress・PHPバージョン、API設定)をご確認ください。

セキュリティ:ドメイン制限の設定

セキュリティのため、ウィジェットが動作するドメインを制限することができます。

ドメイン制限の設定方法

  1. ボット詳細画面を開く
    KnoAskにログインし、ボット詳細画面を開きます。
  2. 設定を開く
    「設定」セクションで、「許可するドメイン」を設定します。
  3. ドメインを追加
    許可するドメインを追加します(例: example.comwww.example.com)。 複数のドメインを追加する場合は、カンマで区切ります。
  4. 保存
    設定を保存します。これで、指定したドメイン以外ではウィジェットが表示されなくなります。

🔒 セキュリティのベストプラクティス
本番環境では、必ずドメイン制限を設定することを推奨します。これにより、不正なサイトでウィジェットが使用されることを防げます。

動作確認

ウィジェットを設置したら、以下の点を確認してください:

  1. ウィジェットが表示されるか
    floatingでは画面右下(または左下)にチャットボタン、inlineでは指定した要素内にチャット欄が表示されるか確認します。
  2. チャットが開けるか
    チャットボタンをクリックして、チャットウィンドウが開くか確認します。
  3. 質問に回答できるか
    簡単な質問を入力して、AIが回答を返すか確認します。

トラブルシューティング

ウィジェットが表示されない

以下の点を確認してください:

  • ボットトークンが正しく設定されているか
  • スクリプトタグが</body>タグの直前に配置されているか
  • ブラウザのコンソールにエラーが表示されていないか(F12キーで開発者ツールを開く)
  • ドメイン制限が設定されている場合、現在のドメインが許可されているか

「このドメインは許可されていません」と表示される

ボットの設定で、現在のドメインが許可されていません。以下のいずれかの方法で解決できます:

  • ボット設定で、現在のドメインを許可するドメインリストに追加する
  • ドメイン制限を解除する(開発環境の場合)

チャットが開かない

以下の点を確認してください:

  • インターネット接続が正常か
  • API URLが正しく設定されているか
  • ブラウザのコンソールにエラーが表示されていないか

回答が返ってこない

以下の点を確認してください:

  • ボットにナレッジがアップロードされているか
  • ナレッジの処理が完了しているか(ステータスが「完了」になっているか)
  • 質問の内容が、アップロードしたナレッジに関連しているか

次のステップ

ウィジェットの設置が完了したら、以下のページも参照してください: