Interactions with virtual agents are typically conducted using chat/messaging tools, voice channels, or digital assistants. In the majority of the cases, the virtual agents respond to the user queries only when the users have requested some information. This works well for conducting on-demand tasks that need user input for execution and the result is usually a short response, confirmation, or acknowledgment. But, with the emergence of Digital Assistants, the need for proactive updates to users through engaging user interface has become a key requirement. This can be achieved by providing engaging interfaces that present relevant information to end-users with minimal need for user input. These interfaces can also trigger mobile/web apps from within the chatbot.

Using Digital Views from the Kore.ai Bots platform, you can design interactive components, panels, and widgets, to proactively present relevant information to your customers. Panels are the placeholders that hold one or more widgets. Widgets are individual components that display information to the end-users. Your customers can interact with your bot either in conversation mode or directly get the required information from the widgets.

This document gives an overview of the working and implementation of Panels & Widgets. For an step-by-step usage instructions, refer to this how to.

Setup

You can access Digital Views from under the Digital Skills menu under Build and setup Panels and Widgets.

Following are the steps to setting up Panels and Widgets:

• Configure Widgets: Define widgets by connecting them either to your bot tasks or any other source like JavaScript generating JSON file. In cases where you are using the bot task as a source, ensure that the message is formatted properly for the Widget SDK channel.
• Preview the Widgets: Preview your widgets from the Bot Builder.
• Set up Panels: You may create multiple panels and each panel can host widgets that present relevant information. You can use the pre-defined widgets or create new ones.
• Test the Panels to see how the Panels and Widgets are rendered in the chat window.
• Publish the Bot: Publish the bot so that the panels and widgets are made available for your end-users.
• Host the Panel: You can choose to host your widgets independently or co-host them along with the web SDK. You can download the SDKs from the Kore.ai GitHub page. Do ensure to enable WidgetSDK as a channel.

Configure Widgets

Widgets are individual components that can communicate with the bot for presenting information to the end-users. The source of information for widgets is from a Dialog Task or a JSON using any of the pre-defined widget templates.

To configure widgets, follow the below steps:

1. Click Create Widget to create a widget.
   
2. On the New Widget window, enter the following details:
   • Name of the widget
   • Display Name for the widget
   • Auto Refresh to set the frequency with which this widget needs a poll for fresh data. The refresh is applicable only when the panel containing the widget is active.
   • Source for a widget can be either from the execution of Dialog Task or from JavaScript defining a JSON:
     • JSON is specified in the JavaScript Editor that is presented.
       
     • Dialog Task option allows you to trigger a task and present the output in the widget.
       1. Select Dialog Task drop-down will list all available tasks in the current bot, select one from the list.
          Note: In the connected Dialog Task make sure to use a Message node to present the required information in the widget using any of the supported widget templates.
          You can use the icon next to the Dialog Task to open the Dialog Task for checking the task details like entity names etc.
          
       2. Any entities used by the selected Dialog Task need to be pre-populated with values by mapping Entity Name with Entity Values.
       3. If the selected Dialog Task has any authorization profile defined, the same is displayed here.
   • Save the Widget.
3. After you save, the widget will be In Development state. You can Edit or Delete the widget.
   
4. Edit widget, apart from allowing modification to any of the above fields, will allow you to Run & Preview the widget.
   You can save the preview as the thumbnail display for the widget.

Set up Panels

Panel refers to containers that hold one or more widgets. You can add an existing widget to the panel or create new widgets.

1. Click Create Panel to create a panel.
   
2. On the New Panel window, enter the following details:
   • Name of the Panel.
   • Display Name for the Panel.
   • Panel Icon to display in the chat window (URL to the location).
   • Save the Panel.
3. After you save, the panel will be In Development state.
4. Click Add Widget to add widgets to the panel. Select widgets from the drop-down list.
   
5. You have the following options for a given panel:
   • Edit the panel details;
   • Add Form to add existing forms;
   • Add Widget to add existing widgets;
   • Panel Management to add existing forms/widgets, or remove already added forms/widgets from the panel.
   • Test the individual panel – this opens the talk to bot window along with the panel listing with the current panel active and data presented;
   • Delete the Panel.

   

6. Test panels open the Talk to Bot window listing all the panels with the chat window active. You can interact and test the panels.

Publish

Publish your bot ensuring that the panels and widgets are selected.

Refer here for details on Publishing a Bot

Hosting

Widget SDK is provided by the platform for hosting and managing panels and widgets. You can choose to host your widgets independently or co-host them along with the WebSDK. You can download the SDKs from the Kore.ai GitHub page. Do ensure to enable WidgetSDK as a channel. Refer to this tutorial on how.

通常、バーチャルエージェントとの対話は、チャット/メッセージツール、音声チャネルまたはデジタルアシスタントを使用して行われます。ほとんどの場合、バーチャルエージェントはユーザーが情報を要求した場合にのみ、ユーザーからの問い合わせに応答します。これは、実行にユーザー入力が必要となるオンデマンドのタスクを行う場合に適しており、結果は通常、短い応答、確認、または確認応答になります。しかし、デジタルアシスタントの登場により、魅力的なユーザーインターフェイスを介して、事前のアップデートをユーザーに提供する必要性が必須要件となってきました。これは、最小限のユーザー入力でエンドユーザーに関連情報を提示することのできる魅力的なインターフェイスを提供することで実現可能です。これらのインターフェイスは、チャットBot内からモバイル/ウェブアプリを起動することもできます。

Kore.ai Botプラットフォームのデジタルビューを使用すると、インタラクティブなコンポーネント、パネル、ウィジェットを設計して、顧客関連の情報を事前に提示することができます。パネルは、ウィジェットを1つ以上保持するプレースホルダーです。
ウィジェットは、エンドユーザーに情報を表示する個々のコンポーネントです。 顧客は、会話モードでBotと対話する、またはウィジェットから必要な情報を直接得ることができます。

注：この機能はプラットフォームのバージョン7.2で導入されました。

この文書では、パネルおよびウィジェットの操作と実装の概要について説明しています。ステップごとの使用方法については、こちらのハウツーを参照してください。

設定

Botタスクメニューからデジタルビューにアクセスして、パネルとウィジェットを設定することができます。

以下は、パネルとウィジェットの設定方法です。

• ウィジェットの設定：BotタスクやJavaScript生成JSONファイルなどのソースに接続してウィジェットを定義します。Botタスクをソースとして使用している場合は、メッセージがウィジェットSDKチャネル用に適切に書式設定されていることをご確認ください。
• ウィジェットのプレビュー：Botビルダーからウィジェットをプレビューします。
• パネルの設定：お客様は複数のパネルを作成することができ、それぞれのパネルは関連情報を表示するウィジェットをホストすることができます。事前定義済みのウィジェットを使用することも、新しいウィジェットを作成することもできます。
• パネルのテストでは、チャットウィンドウでパネルやウィジェットがどのように表示されるかを確認することができます。
• Botの公開：Botを公開して、パネルやウィジェットをエンドユーザーが利用できるようにします。
• パネルのホスティング：ウィジェットを独立してホストするか、ウェブSDKと一緒にホストするかを選択することができます。Kore.ai GitHubページからSDKをダウンロードすることができます。ウィジェットSDKをチャネルとして有効化します。

ウィジェットの設定

ウィジェットは、エンドユーザーに情報を提示するためのBotと通信可能な個別のコンポーネントです。ウィジェットの情報ソースは、ダイアログタスクまたは事前定義済みのウィジェットテンプレートのいずれかを使用したJSONから取得することができます。

ウィジェットの設定方法：

1. ウィジェットの作成ボタンを使用してウィジェットを作成します。
2. 新しいウィジェットのポップアップ画面で、以下の情報を入力します。
   • ウィジェットの名前
   • ウィジットの表示名
   • 自動更新で、このウィジェットが新規のデータ用にポーリングを行う頻度を設定します。更新はウィジェットを含むパネルが有効な場合にのみ適用されます。
   • ウィジェットのソースは、ダイアログタスクの実行から、またはJSONを定義するJavaScriptからのいずれかになります。
     • JSONは、表示されたJavaScriptエディタで指定することができます。
       
     • ダイアログタスクオプションでは、タスクをトリガーしてウィジェットに出力を表示することができます。
       1. ダイアログタスクの選択 ドロップダウンは、現在のBotで利用可能なすべてのタスクがリストアップされています。リストから1つ選択してください。
          注：サポートされているウィジェットテンプレートのいずれかを使用して必要な情報をウィジェットに表示するために、必ずメッセージノードを使用してください。
          ダイアログタスクの横にあるアイコンからダイアログタスクを開き、エンティティ名などのタスクの詳細を確認することができます。
          
       2. 選択されたダイアログタスクで使用されるエンティティは、エンティティ名とエンティティ値をマッピングすることで、あらかじめ値を入力しておく必要があります。
       3. 選択されたダイアログタスクに認証プロファイルが定義されている場合は、ここに表示されます。
   • ウィジェットを保存します。
3. 保存されると、ウィジットは開発中の状態になります。ウィジットを編集または削除することができます。
   
4. 編集ウィジェットでは、上記のフィールドを変更できるほか、ウィジェットの実行およびプレビューを許可します。
   プレビューをウィジェットのサムネイル表示として保存することができます。

パネルの設定

パネルとは、1つ以上のウィジェットを保持するコンテナのことを指します。既存のウィジェットをパネルに追加したり、新しいウィジェットを作成したりすることができます。

1. パネルの作成ボタンを使用してパネルを作成します。
   
2. 新しいパネルのポップアップ画面で、以下の情報を入力します。
   • パネルの名前
   • パネルの表示名
   • 自動更新で、このウィジェットが新規のデータ用にポーリングを行う頻度を設定します。更新はウィジェットを含むパネルが有効な場合にのみ適用されます。
   • パネルアイコンをチャットウィンドウ（場所のURL）に表示します。
   • パネルを保存します。
3. 保存されると、パネルは開発中の状態になります。
4. ウィジェットの追加ボタンを使用してパネルにウィジェットを追加します。ドロップダウンリストからウィジェットを選択します。
   
5. 指定されたパネルには、以下のオプションがあります。
   • パネルの詳細を編集します。
   • パネルの管理で既存のウィジェットを追加したり、新しいウィジェットを作成したり、すでに追加されたウィジェットをパネルから削除したりすることができます。
   • 個々のパネルをテストする – 有効かつデータが表示されている現在のパネル一覧とともに、Botと話すウィンドウが開きます。
   • パネルを削除します。

   

6. テストパネルは、チャットウィンドウが有効になっているすべてのパネルの一覧が表示されるBotと話すウィンドウを開きます。パネルと対話したり、パネルをテストしたりすることができます。

公開

パネルとウィジェットが選択されていることを確認して、Botを公開します。

Botの公開の詳細についてはこちらを参照してください。

ホスティング

ウィジェットSDKは、パネルやウィジェットをホスティングして管理するためのプラットフォームによって提供されています。ウィジェットを個別にホストするか、ウェブSDKと共同でホストするかを選択できます。SDKは、Kore.aiGitHubページからダウンロードできます。ウィジェットSDKをチャネルとして有効にしてください。方法については、このチュートリアルを参照してください。