この機能はプラットフォームのバージョン7.3でリリースされたもので、（ベータ版）の状態です。

[バーチャルエージェントは、主に一連のメッセージのやり取りを含む会話型インターフェイスを使用してエンドユーザーと関わります。しかし大抵の場合、続行するにはエンドユーザーから情報を収集することが必要になります。例として、eコマースエージェントとのやりとり中に配送先住所を提供する、ITSMエージェントへの報告中に問題の詳細を提供する、CRMオポチュニティの作成中にオポチュニティの詳細を提供する、銀行口座を作成するために顧客の詳細情報を取得する、などが挙げられます。

標準のダイアログタスクでは、このシナリオは一連のエンティティノードを配置して設計されており、ユーザーはこれらのエンティティの値を次々に要求されますが、これは非常に面倒で煩わしいものです。これらの代わりとして、ユーザーからすべての情報を簡単かつ効率的に取得するための対話型のユーザインタフェイスが理想的です。

Kore.aiのデジタルフォームは、エンドユーザーから必要な詳細情報を取得するために必要な入力フィールドに情報を入力することで、このような要件に対応しています。ユーザーがフォームに入力した後、入力した内容をバーチャルエージェントに送信し、タスクを進めることができます。

この文書では、Kore.ai Botプラットフォームのデジタルフォームの機能と実装について説明しています。デジタルフォームの段階的な実装についてのユースケースに移動するには、こちらをクリックしてください。

フォームの作成

デジタルフォームは、定義、およびユーザー入力を取得するための様々なコンポーネントを含みます。

フォーム作成の手順：

1. 左側のナビゲーションメニューから、Botタスクを選択し、デジタルフォームを選択します。
2. 新しいフォームボタンを使用してフォームを作成します。
3. 新しいフォームページで以下の情報を入力します。
   • フォームの名前
   • フォームの表示名
   • フォームの説明
4. フォームの作成を保存して続行します。

コンポーネントの追加

• 左側のパネルで利用可能なコンポーネントをキャンバスにドラッグ＆ドロップし、プロパティを設定してフォームを作成することができます。コンポーネントおよびプロパティの詳細については、下記を参照してください。
• 指定されたコンポーネントを検索したり、リストをスクロールしたりすることができます。
• グリッド形式で表示します。

フォーム操作

フォームの一覧ページからは以下のことが行えます。

• 新しいフォームを作成します。（上記を参照）
• フォームを編集します。（下記を参照）
• ブランディングオプションを使用してフォームをカスタマイズします。（こちらを参照）
• フォームをテストします。（こちらを参照）
• フォームを削除します。

編集

フォーム一覧の 編集 オプションを使ってフォームを編集することができます。以下の操作は編集モードでフォームに対して実行することができます。

• コンポーネントリストを使用すると、ドラッグ＆ドロップの簡単な操作でコンポーネントを選択してフォームに追加することができます。
• トグラーの表示を使用して、デスクトップビューとモバイルビューを切り替えます。
• それぞれのコンポーネントに対してハンドルバーを使用して、ドラッグ＆ドロップの簡単な操作で位置を変更します。
• フォームアクションを使用して以下を実行します。
  • フォームをテストして、Botビルダーのデジタルフォームのプレビューを確認する
  • フォームを削除する
  • 名前、表示名、説明などのフォーム設定を変更する
• コンポーネントアクションを使用して、コンポーネントの設定、複製、および削除を利用します。
• コンポーネントの設定ポップアップからコンポーネントのプロパティを変更することができます。
  • コンポーネントドッカーを使用して、設定パネルを画面にドッキング/ドッキング解除します。
  • コンポーネントセレクタを使用して、フォーム上のコンポーネントを検索します。

ブランディング

ブランディング オプションを使用して、組織の標準を反映するようにフォームの外観を変更します。すぐにプレビューが表示され、新しい色でフォームがどのように見えるかが分かり、保存またはデフォルトに戻すスキームのオプションを選択することができます。

テスト

フォームをテストしてプレビューを確認します。

フォームの呼び出し

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

1. タスクから：タスクを定義するためのダイアログタスクのコンポーネントとしてフォームを含めることができます。ダイアログタスクには、フォームデータを入力するための「フォーム体験」および通常の「会話体験」があります。「やり取りのチャネル」またはその他の基準に基づいて、要件に応じて好きな方を選択することができます。
2. UIフローから：パネルにデジタルフォームを追加し、パネルからフォームが送信されたときにトリガーされるダイアログタスクを選択することができます。

以下のセクションでは、上記のそれぞれの呼び出しプロセスについて説明しています。

タスクから

デジタルフォームは、フォームノードを介してユーザー入力を取得するために、ダイアログタスク内で使用することができます。

ダイアログタスクからフォームを呼び出す手順

1. デジタルフォームを呼び出したい場所からダイアログを作成/開きます。
2. フォームを追加したいノードの隣にある＋をクリックします。
3. フォームオプションを選択し、表示されたリストからフォームを選択します。デジタルフォームを直接追加するか、既存のフォームノードを使用するかを選択することができます。
   
4. フォーム体験を選択するように促されます。
   
   • • フォームUIのみ – フォームノードを作成し、選択されたデジタルフォームと関連付けられます。こちらはデフォルトのオプションです。
       
     • フォームUIおよび会話体験の両方 – こちらを選択した場合、さらにチャネルの選択が促されます。ユーザーが選択したチャネルのいずれかを使用している場合にはフォームUIが表示され、それ以外のチャネルのユーザーは会話体験が提供されます。
       
       このオプションは、以下を作成します。
       • 以下のノードを含む グループ（詳細はこちら）。グループ化の名前を変更したり削除したりすることができます。
         • 選択されたチャネルに基づいてフォームノードとサブダイアログノードへの転送を決定するためのロジックノード。
         • 上記の「フォームUIのみ」で生成されたものと同じ、デジタルフォーム用のフォームノード。
         • 会話体験に必要なエンティティ（コンポーネントを使用してデジタルフォームで定義されている）を取得するためのサブダイアログノード。マッピングについては以下を参照してください。

         

5. 追加されたそれぞれのノードにプロパティを設定することができます。
   • フォームノード（詳細はこちら）。
     特に注目すべき点は、以下のコンポーネントプロパティです。
     • メッセージの送信 – フォームの送信が成功した際にエンドユーザーに表示されるメッセージです。
     • ウェブ/モバイルSDKフォームの動作 – このオプションを使用すると、フォームをチャットウィンドウにインライン表示するか、ページ全体で開くことができます。
   • ロジックノードは、会話体験フローの場合にも設定可能です。（詳細はこちら）
     特に注目すべき点は、以下の事項です。
     • コンテキスト変数の管理は、コンテキスト変数の作成や値の設定に使用することができます。キーフィールドには、変数のフルパスを使用することを忘れないようにしてください。（例：context.BotUserSession.）
     • Botのパフォーマンスに影響を与える可能性があるため、接続設定には変更を加えないことを強くお勧めします。
   • サブダイアログノードは、通常通りに設定できます。（詳細はこちら）
     特に注目すべき点は、以下の事項です。
     • エンティティの割り当て後を使用して、ユーザー入力を取得します。
       
     • サブダイアログやソースフォームを変更した場合、ダイアログの再生成というオプションが表示されます。これにより、タスク全体を再構築しなくとも変更をタスクに反映させることができます。このサブダイアログが使用されるすべての場所で変更が反映されることにご注意ください。
       
6. ユーザー入力は以下のようにアクセスできます。
   • フォームのコンポーネントの値には、{{context.forms..}}を使用してアクセスすることができます（詳細はこちら）。
   • サブダイアログの場合は、割り当て後の設定で使用する変数を{{context.}}とします。
7. お客様のビジネスニーズに応じてダイアログタスクを続行することができます。例えば、データ更新のためにフォームコンポーネントの値をサービスノードへの入力として使用したり、スクリプトノードを使用してさらに処理を行ったりすることができます。会話体験も使用している場合、自動生成されたサブダイアログをプロセスフローに接続することを忘れないようにしましょう。

パネルから

ウィジェットとパネルを設定することで、デジタルビューでデジタルフォームを表示することができます。デジタルビューの詳細についてはこちらを参照してください。

ウィジェットとパネルを使用してフォームを呼び出す手順

1. ウィジェットを作成してデジタルフォームを呼び出します。
   1. 名前を入力します。
   2. デジタルフォームをソースとして選択します。
   3. ドロップダウンリストから選択してフォームを追加します。
   4. ドロップダウンリストから送信時に呼び出すダイアログを選択します。
      デジタルフォームを使用して、複数のウィジェットを定義したり、複数のパネルに追加したりすることができますが、すべてのウィジェットとパネルにまたがる単一のダイアログタスクに関連付けられることにご注意ください。
   5. ウィジェットを保存します。
      
2. 既存のパネルにウィジェットを追加するか、新しいパネルを作成します。
   パネルに直接フォームを追加すると、デフォルトでウィジェットが作成されます。
   
3. パネルをテストすることができます。
4. パネルを公開およびホストするには、こちらに記載されている手順に従ってください。

プロセスフロー

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

• フォーム体験：
  • フォームへのリンクがユーザーに提示されます。
    同期Webhookチャネルでは、リンクの代わりに完全なフォーム定義が送信されることにご注意ください。詳細はこちらを参照してください。
    
  • リンクをクリックすると、選択した内容に基づいて、全画面またはインラインモードでフォームを開くことができます。リンクに関して特に注目すべき点は、以下の通りです。
    • リンクは一定期間のみ有効で、それ以降は無効になります。
    • 有効期間内であっても、限られた回数しか使用できません。
  • エンドユーザーは、コンポーネント/フィールドの値を入力することができます。
    
  • すべてのフォームにはデフォルトで送信ボタンが含まれています。これはフォームの入力を検証し、不足している値があればプロンプトを表示します。
    
  • フォームが検証されて送信されると、値はコンテキスト変数で使用可能になり、以下のコードを使用してアクセスすることができるようになります。 context.forms..
    ここでは、メッセージノードを使用してユーザーの入力を取得し、表示しています。
    
• 会話体験：
  • エンドユーザーは、操作のチャネルからフォーム内でそれぞれのコンポーネントの値を入力するように促されます。
  • 値はサブダイアログのコンテキストで利用可能になり、上記のようにEntity Post Assignmentを使用して取得することができます。
  • 以下は会話モードでのユーザー体験です。
    

例外

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

パネルフロー

ユーザーは、パネルとウィジェットを使用してフォームにアクセスすることができます。体験は、フォームを使用したプロセスフローの場合と同じです。

フォームが検証されて送信されると、値はコンテキスト変数で使用可能になり、以下のコードを使用してアクセスすることができるようになります。 context.forms..

体験は以下のようになります。

Bot管理

公開

デジタルフォームを使用したBotの公開フローには、以下のような特殊なケースがあります。

• 他のBotと同様に、デジタルフォームは以下の状態で存在します。
  • フォームが作成された場合、開発中
  • フォームが公開に投稿され、リクエストが管理者のアクションを待っている場合、承認待ち
  • 管理者によって公開リクエストが拒否された場合、拒否
  • 管理者が公開リクエストを承認した場合、公開済み
  • 公開済みのフォームが管理者によって一時停止された場合、一時停止
• 公開リクエストが処理される前に、以下の検証が行われます。
  • デジタルフォームを含むダイアログタスクは、以下の場合にのみ公開することができます。
    • 対応するデジタルフォームが既に公開されている
    • 対応するデジタルフォームも公開用に選択されている
  • ダイアログタスクを起動するように設定されたデジタルフォームは、以下の場合にのみ公開することができます。
    • 対応するダイアログタスクが既に公開されている
    • 対応するダイアログタスクが公開用に選択されている
  • 依存関係は一緒に公開されますが、次のような場合、実行時にすべての依存関係が利用できない可能性があります。
    • ダイアログタスクは公開されているがデジタルフォームが公開されていない場合、以下がトリガーされます。
      • タスクの失敗イベントとそれに対応する動作が呼び出される
      • 関連する標準応答が表示される
      • 「分析」で失敗したタスクとしてログに記録される
    • デジタルフォームは公開されている状態であるがダイアログタスクが利用できない場合、フォーム送信時にエンドユーザーにフォームのエラーメッセージが表示されます。

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

Botのエクスポート

• 開発中および公開済みのコピーでデジタルフォームをエクスポートするオプションが利用可能です。
• デジタルフォームは、BotタスクのカテゴリのBotエクスポートページから選択/解除することができます。
• 「依存ダイアログを含む」オプションを選択して、ウィジェットを定義するために選択したデジタルフォームと統合されたダイアログタスクをエクスポートします。これにはデジタルフォームを使用して生成されたサブダイアログタスクは含まれないことにご注意ください。
• 選択されたそれぞれのフォームの完全な情報はエクスポートファイルで利用可能です。これには以下が含まれます。
  • フィールド
  • フィールドプロパティ
  • フォームの統合

Botのインポート

• デジタルフォームは、Botの完全および増分インポートに含まれています。
• フルインポートの場合：
  • フルインポートは、他のすべてのBotコンポーネントと同様に、デジタルフォーム全体とBot内のフォームの詳細を置き換えます。
• 増分インポートの場合：
  • インポートにデジタルフォームを含めるかどうかを選択することができます。
  • このインポートにより、インポートファイルに共通のデジタルフォームが完全にBotに置き換えられます。
  • ファイル内の追加フォームはBotにインポートされます。
  • Bot内の追加フォームは保持されます。
  • インポート後、無効なデジタルフォームの統合の詳細は、対応するフォームと切り離されます。

コンポーネントの詳細

コンポーネントリスト

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

コンポーネント	説明	サンプル
ベーシック
	テキストフィールド – 一行入力に使用されます。
	テキストエリア – 複数行入力に使用されます。
	数値 – 数値エントリに使用されます。
	ラジオボタン – 与えられたリストの選択オプションとして使用されます。
	ドロップダウン – 与えられたリストの選択オプションとして使用されます。複数選択可能です。
	チェックボックス – 与えられたリストの複数選択オプションとして使用されます。
	日付 – 日付の入力に使用され、ユーザーが日付を選択するためのDatepickerを与えます。
	日付および時間 – 日付と時間の入力に使用され、ユーザーが日付と時間を選択するためのDateTimePicker与えます。 日付コンポーネントを使用して時間オプションを「はい」に設定し、12時間または24時間フォーマットから選択します。
	電話番号 – 電話番号の入力に使用され、ユーザーが国コードを選択できるようにします。
	メール – メールアドレスの入力に使用され、xxx@uuu.com形式で検証されます。
	トグル – 2つの値の切り替えに使用され、はい/いいえ形式の入力に最適です。
	住所 – 住所の入力に使用されます。
	URL – ウェブURLの入力に使用され、xxx.com形式で検証されます。
	範囲スライダー – 指定された最小値と最大値の間で値を選択します。パーセンテージで表すことができます。
詳細
	ボタン – フォームを送信、リセット、または外部URLを開くためのクリック可能なコンポーネントとして使用されます。Primary、Secondary、Tertiary、Ghost、Dangerから選択できます。
	ラベル – 静的なテキストボックスを表示するために使用されます。ユーザーによる操作は不要です。
	プロチップ – エンドユーザーにとって重要な情報をマークするために使用します。ユーザーによる操作は不要です。
	注釈 – エンドユーザー向けの情報をマークするために使用されます。ユーザーによる操作は不要です。

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

それぞれのコンポーネントに設定可能なプロパティは以下の通りです。

注：すべてのプロパティがすべてのコンポーネントに対して有効であるとは限りません。マッピングについては、プロパティマトリックスを参照してください。

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

プロパティ

ベーシック

詳細

ダイアログノード

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

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

以下のマッピングは、サンプルコンテキストオブジェクトとともにコンポーネント値を取得するためのコンテキストオブジェクトを提供します。

制限事項

• 以下のチャネルでは、デジタルフォームは予測通りに動作しません。
  • Amazon Alexa
  • Cisco Jabber
  • Google Assistant
  • IVR Voice
  • Twilio Voice

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

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