バーチャルエージェントは、一般的に一連のメッセージ交換を含む会話形式インターフェースを主に使用して、エンドユーザーと関わります。しかし、その先に進むためには、エンドユーザーから情報を収集する必要があることも少なくありません。例としては、eコマースエージェントと対話しながら配信アドレスを提供したり、 ITSMエージェントに報告しながら問題の詳細を提供したり、 CRM案件を作成しながら、あるいは銀行口座を作成するために顧客情報をキャプチャしながら、案件の詳細を提供したりします。標準ダイアログタスクにおいては、このシナリオは一連のエンティティノードを連続的に接続し、ユーザーはこれらのエンティティごとに値を順番に入力する必要があり、これは非常に面倒で神経を使う作業となります。その代わりに、ユーザーからすべての情報を簡単かつ効率的にキャプチャできるインタラクティブなユーザーインターフェースは理想的なものになります。Kore.aiのデジタルフォームは、必要な情報をエンドユーザーからキャプチャするためにさまざまな入力フィールドを提供して、そのような要件に応えます。ユーザーがフォームに入力し終わると、その入力内容がバーチャルエージェントに送信され、タスクが続行します。このドキュメントにおいて、Kore.ai Botsプラットフォームのデジタルフォームの機能と実装についてお話しします。デジタルフォームを段階的に導入するユースケースの例にジャンプするには、 ここをクリックしてください。

フォームの作成

デジタルフォームには、ユーザー入力をキャプチャするための定義およびさまざまなコンポーネントが含まれています。フォーム作成するには、以下のステップに従います：

1. 構築のトップメニューで、デジタルスキルを選択します。
2. デジタルフォーム＞新規作成をクリックします。
3. 新しいフォームのページで、以下を入力します。
   • フォームの名前
   • フォームの表示名
   • フォームの説明
4. フォームセキュリティ – セキュアフォームデータによって、ボットコンテキスト、デバッグログ、サービスコール、エージェントへの転送、およびボットキットからフォームデータを編集することができます。プラットフォームは、有効になった後、あらゆるモジュールにおいて、ユーザー入力を、ランダムにシステム生成された固有の英数字に置き換えます。
5. 保存して続行をクリックします。

コンポーネントの追加

• 左側ペインに用意されているコンポーネントをキャンバスにドラッグアンドドロップし、そのプロパティを設定してフォームを構築することができます。コンポーネントとそのプロパティの詳細については、 以下をご参照ください。
• 任意の指定されたコンポーネントを検索したり、リストをスクロールすることができます。
• グリッド形式で表示します。

フォームアクション

フォーム一覧ページから、以下のことができます。

• 新しいフォームは、上記をご参考に作成します。
• フォームの編集は、以下をご参照ください。
• ブランディングオプションを使用してフォームをカスタマイズするには、 こちらをご覧ください。
• フォームをテストするには こちらをご覧ください。
• フォームを削除します。

編集

編集オプションを使用して、フォームリストからフォームを編集することができます。編集モードのフォームにおいて、以下のアクションが実行されます。

• コンポーネントリスト は、簡単なドラッグアンドドロップの操作で、コンポーネントを選択してフォームに追加するために使用できます。
• ビュートグラーを使用して、デスクトップビューとモバイルビューを切り替えます。
• 各コンポーネントに対してハンドルバー を使用すると、簡単なドラッグドロップ操作でコンポーネントの位置を変更できます。
• フォームアクションを使用して、以下のことができます。
  • ボットビルダーにおいてデジタルフォームのプレビューを見るために、フォームをテストする。
  • フォームを削除します。
  • 名前、表示名、説明などのフォーム設定 を変更する。
• コンポーネントアクションを使用して、設定、複製および削除にアクセスする。
• コンポーネントのプロパティは、コンポーネント設定ポップアップから変更できます。
  • コンポーネントドッカー を使用して、[設定]ペインを画面にドッキング/アンドックする。
  • コンポーネントセレクターを使用して、フォームのコンポーネント間を移動する。

ブランディング

ブランディングオプションを使用すると、組織の基準を反映させてフォームのルック＆フィールを変更できます。インスタントプレビューでは、新しい色でフォームがどのように見えるかを確認することができ、さらに保存またはデフォルトの復元 スキームのオプションもあります。

テスト

プレビューを見るためにフォームをテストします

フォームの呼び出し

以下は、デジタルフォームを呼び出す方法です。

1. タスクから：タスクを定義するためのダイアログタスクに、フォームをコンポーネントとして含めることができます。ダイアログタスクでは、フォーム体験 およびフォームデータを入力するための通常の 会話体験が用意されています。必要があれば、インタラクションのチャネルまたはその他の基準に基づいた優先権を選択することができます。
2. UIフローから：デジタルフォームをペインに追加し、フォームがペインから送信された際にトリガーするダイアログタスクを選択することができます。

以下のセクションにおいて、上記の各呼び出しプロセスについて説明します。

タスクから

デジタルフォームは、フォームノードを通してユーザー入力をキャプチャするために、ダイアログタスクの中で使用されます。ダイアログタスクからフォームを呼び出すためには、以下のステップに従います。

1. デジタルフォームを呼び出したいダイアログを作成し/開くことができます。
2. フォームを追加したいノードの横にある＋アイコンをクリックします。
3. デジタルフォーム オプションを選択し、さらにリストからフォームを選択します。デジタルフォームを直接追加するか、既存のフォームノードを使用するかを選択することができます。
4. フォーム体験を選択するよう指示されますが、それは以下の場合に可能です。
   
   • フォームUIのみ – これはフォームノードを作成し、選択したデジタルフォームと関連付けます。これはデフォルトのオプションです。
     
   • フォームUIと会話体験の両方 – これはさらにチャネルの選択を指示します。ユーザーが選択したチャネルのいずれかを使用しているときは、フォームUIが表示され、それ以外のチャネルのユーザーは会話体験を楽しむことができます。このオプションでは、以下を作成します。
     • 選択されたチャネルに基づいて、フォームノードとサブダイアログノードの遷移を決定するためのロジックノード。
     • 上記のオンリーフォームUIで生成されたものと同じくデジタルフォーム用のフォームノード。
     • 会話体験用に必要なエンティティ（コンポーネントを使用したデジタルフォームで定義されている）をキャプチャするためのサブダイアログノード。マッピングは以下をご参照ください。以下のノードを含むグループ （詳細はこちらをご覧ください）。このグループは名前の変更や削除ができます。
       
5. 追加された各ノードのプロパティを設定することができます。
   • フォームノード （詳細はこちらをご覧ください）。特に注目したいのは、以下のコンポーネントプロパティです。
     • 送信メッセージ – フォームの正常な送信についてエンドユーザーに表示されるメッセージ。
     • Web/モバイルSDKフォーム動作 – このオプションを使用する際、フォームを「チャット」ウィンドウのインライン表示にするか、もしくはフルページで開くこともできます。
   • ロジックノード は、会話体験フローの場合、設定することもできます（詳細はこちらをご覧ください）。 特に注目したいのは、以下のとおりです。
     • コンテキスト変数の管理は、コンテキスト変数の値を作成および設定するために使用されます。キー フィールド、すなわちcontext.BotUserSession.<variable_name>に必ず変数のフルパスを使用してください。
     • 接続設定の変更は、ボットのパフォーマンスに影響するため、絶対に行わないようにしてください。
   • サブダイアログ ノード は通常通りに設定されています（詳細はこちらをご覧ください）。 特に注目すべき点は以下のとおりです。
     • エンティティ事後割り当て を使用して、ユーザー入力をキャプチャします。
     • サブダイアログやソースフォームを変更した場合には、 ダイアログの再生成オプションが表示されます。これにより、タスク全体を再構築する必要がないまま、変更内容がタスクに反映されます。このサブダイアログを使用するあらゆる場所で、変更が反映さていますのでご注意ください。

     

6. ユーザー入力は、以下のようにしてアクセスできます。
   • フォームコンポーネントの値は、以下を使用してアクセスします（詳細はこちらをご覧ください）。 {{context.forms.<form_name>.<component_name>}}
   • サブダイアログの場合は、以下のような、事後割り当て設定で使用する変数 {{context.<variable_name>}}
7. ビジネスニーズに応じて、ダイアログタスクを継続することができます。たとえば、フォームコンポーネントの値をサービスノードの入力として使用してデータを更新したり、スクリプトノードを使用してさらに処理したりすることができます。会話体験も使用している場合は、忘れずに、自動生成されるサブダイアログをプロセスフローに接続してください。

パネルから

デジタルフォームは、ウィジェットとパネルを設定することにより、デジタルビューにレンダリングされます。 デジタルビューの詳細についてはこちらをご覧ください。ウィジェットとパネルを使用してフォームを呼び出すためには、以下のステップに従います。

1. 構築->デジタルスキル->デジタルビューのオプションからデジタルフォームを呼び出すウィジェットを作成します。
   1. 名前を入力します。
   2. デジタルフォームをソースとして選択します。
   3. ドロップダウンリストから選択して、フォームを追加します。
   4. ドロップダウンリストから、送信時に呼び出すダイアログを選択します。なお、デジタルフォームは複数のウィジェットを定義するために、また、複数のパネルに追加するためにも使用されますが、すべてのウィジェットとパネルにわたって、単一のダイアログタスクに関連付けられています。
   5. ウィジットの保存。
      
2. 既存のパネルにウィジットを追加したり、あるいは新しいパネルを作成することができます。パネルに直接フォームを追加することができ、それはデフォルトでウィジェットを作成します。
3. パネルの テスト ができます。
4. ここで用意されているステップに従い、パネルを公開してホストします。

プロセスフロー

エンドユーザーがダイアログを開始し、フォームノードに接続するノードに到達したときに、以下のイベントが発生します。設計時に選択した体験と、呼び出しのチャネル次第では、以下のようなフローになります。

• フォーム体験：
  • フォームへのリンク がユーザーに表示されます。 なお、同期型Webhookチャネルでは、リンクに代わって、完全なフォーム定義が送信されます。詳細はこちらをクリックしてください。
    
  • リンクをクリックすると、選択した内容に応じて、全画面表示またはインラインモードでフォームが開きます。リンクに関する特記メモ：
    • リンクは一定時間だけ有効で、それ以降は無効になります。
    • 有効期間内であっても、限られた回数しか使用できません。
  • エンドユーザーは、コンポーネント/フィールドに値を入力することができます。
    
  • すべてのフォームには、デフォルトで送信ボタンが付いています。これは、フォームのエントリを検証し、未記入の値に対して指示します。
    
  • フォームが検証されて送信されると、その値はコンテキスト変数で使用できるようになり、次のコードでアクセスされます。 context.forms.<form_name>.<component_name> ここでは、ユーザー入力をキャプチャして、メッセージノードを使用し、表示しています。
    
• 会話体験：
  • 操作チャネルから、エンドユーザーはフォーム内のすべてのコンポーネントに値を入力するよう指示されます。
  • 値はサブダイアログのコンテキストで使用可能となり、上述のようにエンティティ事後割り当てを使用して、キャプチャされます。
  • 以下は、会話モードでのユーザー体験です。
    

例外

フォームノードによるダイアログ実行中に例外が生じた場合、以下のように処理されます。

パネルフロー

ユーザーは、パネルとウィジェットを使用してフォームにアクセスできます。体験は、フォーム体験付きプロセスフローの体験と同じです。フォームが検証されて送信されると、その値はコンテキスト変数で使用できるようになり、次のコードでアクセスされます。 context.forms.<form_name>.<component_name> 以下はその体験です。

Bot Management

Publish

The publishing flow for a bot with Digital Forms has the following special cases:

• As with any bot, the Digital Forms exist in the following states:
  • In-development when a form is created.
  • Awaiting approval when a form is submitted to Publish and the request is waiting for the admin to take action.
  • Rejected when the Publish request is rejected by the admin.
  • Published In the Bot Builder, the status of a Digital Form remains In Development even after publishing.
    • • On publishing the form, you can see the form listed under Publish Status → View Publishing Summary, but the status on the Digital Forms main page remains as In Development.
        
      • The In Development and Published versions of the bot can be viewed by toggling between the respective statuses in the top search-bar.

    
    Note: If any edits are done to the Digital Form in In Development version, the changes would be reflected in the Published version as soon as we publish the form.

  • Suspended when a published form is suspended by the admin.
• The following validations are performed before a Publish request is processed:
  • A Dialog Task that contains a Digital Form can be published only if:
    • The corresponding Digital Form is already published, or
    • The corresponding Digital Form is also selected for publishing.
  • A Digital Form that is configured to trigger a Dialog Task is published only if:
    • The corresponding Dialog Task is already published, or
    • The corresponding Dialog Task is selected for publishing.
  • While the dependencies are published together, chances are that all the dependencies might not be available at run-time, in such cases:
    • If the Dialog Task is in a published state, but the Digital Form is not in a published state this triggers:
      • The Task Failure Event and the corresponding behavior is invoked or
      • A relevant Standard Response is displayed and
      • Logged as Failed Task in Analytics.
    • Digital Form is in a published state, but the Dialog Task is not available then on Form submission, the end-user is presented with the Form’s Error Message.

インポート/エクスポート

ボットのエクスポート

• 開発中にデジタルフォームをエクスポートするオプションおよび公開済みのコピーが使用できます。
• デジタルフォームは、ボットタスクカテゴリのボットのエクスポートページで選択/解除できます。
• 選択したデジタルフォームと連携しているダイアログタスクをエクスポートするために、依存ダイアログを含めるオプションを選択して、ウィジェットを定義します。なお、デジタルフォームで作成したサブダイアログのタスクは、これには含まれません。
• 選択された各フォームの完全な情報がエクスポートファイルで使用でき、これには以下が含まれます。
  • フィールド
  • フィールドプロパティ
  • フォームのシステム連携

ボットインポート

• デジタルフォームは、ボットの全体インポートと増分インポートに含まれます。
• 全体インポートの場合：
  • 他のすべてのボットコンポーネントと同じく、全体インポートでは、ボットにおけるデジタルフォーム全体とフォームの詳細が置き換えられます。
• 増分インポートの場合：
  • デジタルフォームをインポートに含めるか/除外するかを選択できます。
  • このインポートでは、インポートファイルとボットに共通するデジタルフォームを完全に置き換えます。
  • ファイル内の追加フォームがボットにインポートされます。
  • ボット内の追加フォームはそのまま残ります。
  • インポート後は、無効なデジタルフォームのシステム連携の詳細は、対応するフォームとの関連付けできなくなります。

コンポーネントの詳細

コンポーネントリスト

以下は、使用可能なコンポーネントのリストです。各コンポーネントのプロパティの詳細については、 以下をご覧ください。

コンポーネント	説明	サンプル
基本
	テキストフィールド – 1行の入力に使用します。
	テキストエリア – 複数行の入力に使用します
	番号 – 数字の入力に使用します
	ラジオボタン – 指定されたリストからの選択オプションとして使用します
	ドロップダウン – 指定されたリストからの選択オプションとして使用します
	チェックボックス – 指定されたリストから複数のオプションを選択するために使用します
	日付 – 日付の入力に使用され、ユーザーが日付を選択するための日付ピッカーを表示します。
	日付と時刻 – 日付と時刻の入力に使用され、ユーザーが日付と時刻を選択するための日付と時刻のピッカーを提供します。日付コンポーネント を使用し、時間オプションを「はい」に設定し、12時間または24時間のフォーマットを選択
	電話番号 – 電話番号のエントリに使用、ユーザーは国コードを選択できます。
	メール – メールアドレスのエントリに使用され、 xxx@uuu.com 形式で検証されます。
	切り替え -2つの値を切り替えるために使用され、はい / いいえタイプの入力に最適です
	アドレス – アドレスのエントリに使用します。
	URL – WebのURLエントリに使用され、xxx.com の形式で検証されます。
	範囲スライダー – 指定された最小値と最大値の間で値を選択します。パーセンテージで表示可能です。
上級
	ボタン – フォームを送信したり、リセットしたり、外部のURLを開いたりするためのクリックできるコンポーネントとして使用されます。プライマリ、セカンダリ、ターシャリ、ゴーストまたは 危険から選択します。
	ラベル – 静的なテキストボックスを表示し、ユーザーのアクションを必要としません。
	プロのヒント – エンドユーザー向けの重要な情報をマークするために使用され、ユーザーのアクションは必要ありません。
	メモ – エンドユーザー向けの情報をマークするために使用され、ユーザーのアクションは必要ありません。

コンポーネントプロパティ

各コンポーネントに設定可能なプロパティは以下のとおりです。メモ：すべてのプロパティがすべてのコンポーネントに有効なわけではありません。マッピングについては プロパティマトリックス をご参照ください。

コンポーネントのマッピング

プロパティ

基本

上級

ダイアログノード

次のマッピングは、デジタルフォームから自動生成されたサブダイアログに含まれるエンティティのタイプを示しています。

コンテキストオブジェクト

次のマッピングでは、コンポーネントの値をキャプチャするためのコンテキストオブジェクトと、コンテキストオブジェクトのサンプルを示しています。

プレフィルフォーム

フォームのフィールドに事前入力用に使用できるデータを指定できます。プラットフォームは、フォームを起動する前に、フォームのプレフィル情報の有無をチェックします。情報がある場合は、ユーザーにフォームを表示する前に、フォームの対応するフィールドに情報が事前入力されます。値は静的なものでも、コンテキストオブジェクトからのものでも構いません。

プレフィルフォームのデータを指定するには、以下のコンテキストオブジェクトを使用します。context.prefillForms。Javascriptで以下を使用すると、上述のコンテキストオブジェクトを入力することができます。

context.prefillForms = {
  <form_name>: {
     fields: {
        <form_field1>: "<value1>",
        <form_field2>: <context.session.....>,
        <form_array_field2>: [
             <array_value1&gt,
             <array_value2&gt,
        ],
     },
  },
};

制限事項

• 以下のチャネルでは、デジタルフォームが正常に動作しません。
  • Amazon Alexa
  • Cisco Jabber
  • Google アシスタント
  • IVRボイス
  • Twilio ボイス

  これらのチャネルでは、会話体験を選択することをお勧めします。

• 親ボットで作成したデジタルフォームは、スマートボットには継承されません。
• ユニバーサルボットでは、デジタルフォーム機能は適用できません。