Paramの定義

Botとの会話中にユーザーから受け取る入力データは、Actionのparamとして記述されます。Actionの実行をフォームへの記入に例えると、フォーム内のフィールドがActionのparamと見なすことができます。

たとえば、イベントを作成するActionのparamは通常以下のとおりです：

• イベントのタイトル
• イベントの開始時間
• イベントの終了時間

ユーザーはこれらの各paramに対して、自然言語で会話形式で値を提供できます。Actionに設定されたparamに基づいて、ConvoKraftはメッセージの意図を自動的に理解し、paramの適切な値を抽出します。

ConvoKraftはNLP能力を使用して、Actionに対して行われた設定と実行時のユーザー入力との一致を行います。特定のparamの宣言されたデータ型に従って、ユーザーの入力を計算値に変換します。paramのサポートされるデータ型については、このページの後半で詳しく説明します。これらのparamは、Botの必要な操作を実行するためにBusiness Logicで使用されます。

paramの実装と使用方法の詳細については、Actionの作成をご覧ください。

Paramの属性

このセクションでは、paramのさまざまな属性について詳しく説明します：

1. Param名

   paramの有効な名前は、以下のポイントに準拠する必要があります：

• 小文字で始まること
• 数字と文字のみ使用可能
• 最大50文字
• すべてのActionで一意であること
• ConvoKraftの予約語として以下の名前はparamとして使用できません：userInput、previousParam、additionalParams、sessionData、broadcast、previousUserMsgs、cache、org、user

2. Param型

ConvoKraftでサポートされている型のリストからparamに必要なデータ型を選択できます：

ファイルparamについて、サポートされるファイルタイプは以下のように定義できます：

Single and Multiple Selection List

Single selection listおよびMultiple selection listのparamについては、以下の追加情報を入力する必要があります：

1. Options：ユーザーが1つまたは複数の選択肢を選択できる利用可能なオプションのリストです。

   コードを使用せずに静的にオプションを設定できます。ユーザーが理解できる明確な値をすべてのオプションに設定することを推奨します。すべてのオプションにはIDがあり、プログラム上でオプションを一意に識別するために使用されます。すべてのオプションのIDを手動で入力するか、オプションを入力する際に自動生成されたIDを使用できます。選択リストオプションの有効な名前とIDは、以下のポイントに準拠する必要があります：

   • IDは英数字、ハイフン、アンダースコアのみサポート
   • オプション名は最大150文字
   • 選択リストparamには最大50のオプションを設定可能

2. Buttons：ボタンは、選択された選択リストオプションに対して実行されるActionsを表します。カスタムボタンが設定されていない場合、デフォルトのアクションは選択された選択リストオプションの送信です。

   ボタンのプロパティには以下が含まれます：

• Label - ボタンの表示テキスト。

• ID - 会話中にどのボタンが選択されたかをBusiness Logicが一意に識別するための識別子。

• Theme - 会話中のボタンの外観を反映するカラースキーム。以下の3つのテーマがサポートされています。

  1. Positive
  2. Negative
  3. Neutral

  ボタンの有効な名前とIDは、以下のポイントに準拠する必要があります：

• ボタン名とIDには、すべての英数字と特殊記号を含めることができます。

• 最大150文字を含めることができます。

• 選択リストparamには最大3つのボタンを設定できます。

3. Allow values other than these options：このオプションにより、定義したオプションリストから選択するのではなく、ユーザーが独自の値を送信できるようになります。このオプションが有効になっている場合、そのような値のIDはnullに設定されます。

4. Mode of Input：ユーザーがparamに値を提供する方法を指定します。TextualまたはVisualのいずれかです。Textualを選択した場合、ユーザーはparamに割り当てたい値を入力できます。Visualの場合、ユーザーは利用可能な視覚的オプションから入力を選択する必要があります。オプションはラジオボタン（Single selectionの場合）、チェックボックス（Multiple selectionの場合）、または日付/時間ピッカー（Date/Time Rangeの場合）として表示されます。

5. Prompt Message：ユーザーとのBot会話の一部として、Botがユーザーにparamの入力を求める質問です。たとえば、イベント作成Actionでイベントの開始時間の値を取得するには、プロンプトメッセージを**「イベントは何時に始まりますか？」や「イベントはいつですか？」**のように設定します。このフィールドは空にできず、以下のポイントに準拠する必要があります：

   • #、/、\、&、*、+、=、()を除くすべての英数字と特殊記号を含めることができます。
   • 最大255文字を含めることができます。

   範囲を含むparamの場合、プロンプトメッセージフィールドは以下に分割されます：

   • Start of the Range：範囲の開始値を取得するためのプロンプトメッセージ。
   • End of the Range：範囲の終了値を取得するためのプロンプトメッセージ。

6. Prompt message on validation failure：プロンプトされたparamに対してユーザー入力が無効と判定された場合にユーザーに表示されるカスタムメッセージです。このフィールドは任意です。

7. Allow to skip：Botとの会話中にparamへの回答をスキップすることをユーザーに許可します。

Paramの定義

このセクションでは、ConvoKraft ActionにおけるParamの使用方法を説明するためのいくつかの例シナリオを説明します：

• ユーザーがオンライン注文の返品リクエストを開始する必要があるシナリオを考えてみましょう。ユーザーは次のような質問をするでしょう：

「注文を返品したいです」

「注文を返品して」

「この商品を返品して返金をリクエストして」

返品リクエストの開始時にユーザーから詳細を取得するためにparam order idを作成し、Sample Sentencesの任意のフレーズにparamを関連付けることができます。これにより、ユーザーが返品について問い合わせると、Botはすぐに注文番号を尋ねるプロンプトを表示します。

• カレンダーに会議をスケジュールする別のシナリオを考えてみましょう。

ユーザーは次のようなものを入力するでしょう：

「明日の午後5時にカレンダーに会議をスケジュールして」

「明日の会議を追加して」

この場合、eventname(String)、eventtype(Single selection list)、eventdays(Multi-selection list)、eventtime(Date/Time Range)などのparamを作成できます。

ConvoKraft BotのAction作成時にparamを設定する方法については、Actionの作成を参照してください。