情報タスク

接続モードがRESTに設定されているアクションタスクのリクエストでは、以下のように定義する必要があります。

• 認証 – アクションタスクに必要な場合、APIにアクセスするための認証を定義する必要があります。例：基本認証、OAuth、API Keyなどの使用。詳細は、上記の認証の設定をご覧ください。
• パラメータ – APIリクエストの処理に使用される1つ以上のパラメータを定義します。例：ユーザープロンプトからの入力、選択肢リストからのエンドユーザーによる選択、URLなど。詳細は、以下のアクションタスクのパラメータを定義するをご覧ください。
• イニシャライザ(オプション) – 実行するカスタムJavaScriptを指定したり、Webサービスでコードの実行が必要な場合にタスクインスタンスを作成する前にセッション変数を設定したり、APIリクエストを実行する前にユーザーコンテキストの詳細を変更したりすることができます。詳細は、以下の「 イニシャライザの定義をご覧ください。
• リクエスト – WebサービスへのAPIコールを行うこと、ボットへのURLとパスを使用してアクションタスクを開始すること、およびWebサービスからボットプラットフォームへのデータペイロードの配信を開始することなどに使用されるリクエストチェーンを定義します。リクエストチェーンは、プリプロセッサ、APIリクエスト、およびポストプロセッサから成ります。詳細は、以下の「 リクエストチェーンの定義をご覧ください。
• 応答サンプル – アクションタスクのペイロードで受け取ることが想定されるキー/値のペアを定義します。ボットユーザーに表示するデータを処理するために、提供されたキーがドロップダウンの選択肢として利用できます。詳細は、以下の応答サンプルの追加をご覧ください。

以下の手順で、APIリクエスト（REST）のパラメータを定義します。

1. パラメータのセクションをクリックして、次に追加をクリックします。  タスクパラメータの設定ダイアログが開きます。
2. ご選択の次第、下記のテーブルの説明の通りに関連のフィールド値を入力してください。
   

   フィールド名	説明
   タスク パラメーターのタイプ	次のうちの 1 つを指定します。 ペイロード パラメーター – POST、PUT、GET、DELETE などの HTTP メソッドによるフィールド タイプでペイロード データを示します。例： { "taskId":"{payloadfield2}", "message":"{payloadfield1}" } クエリパラメータ – このフィールドタイプは、URLパスの一部またはURL内のクエリとして使用されます。例： http://app.asana.com/api/workspaces/{queryfield1}/project/{queryfield2}?userId={queryfield3}
   パラメータ名	ユーザーに表示されるタスク入力フィールドのタイトル（例： アカウントを選ぶ
   プロンプトメッセージ	パラメータ名の下に表示されるヘルプの説明。例：どちらのアカウントにアクセスしたいですか？
   パラメータキー	収集したいエンドユーザーの入力値を表すタスクキー（例： accountType）。
   必要エンティティのタイプ	入力パラメータはエンティティに関連付けられ、エンティティタイプを選択することができます。 添付ファイル 都市 国 会社 通貨 日付 メール ラベル 場所 メッセージ 名前 数字 パーセント 電話番号 文字列 エンティティタイプの詳細は、こちらをクリックしてください。選択されたエンティティタイプに基づいて、残りのパラメータが設定されていますが、これを変更することができます。
   パラメータタイプ	キーの値に割り当てるリクエストオブジェクト用のユーザー入力を収集するためにエンドユーザーインターフェースに表示されるタスク入力フィールドのタイプを指定します。デフォルト設定はテキストボックスですが、以下のいずれか1つをカスタマイズできます。 日付 – フォーマットフィールドが表示され、エンドユーザーが自分のアカウントにタスクが設定される際に定義する日付フォーマットの構文を選択できます。日付フォーマット選択のドロップダウン リストから、次のうちの1つを選択します。 dd-MM-YYYY – 例:16-05-1999 MM-dd-YYYY – 例:05-16-1999 dd-MM-YY – 例:16-05-99 YYYY-MM-dd – 例:1999-05-16 URL – 正しい URL 構文のためのフィールド検証を含む、エンドユーザーによる URL 入力用のテキスト ボックスを表示します。プレースホルダーフィールドには、テキストボックスに表示されるヘルプヒントを入力します。例：こちらにWebサイトのURLを入力してください。 テキストボックス―エンドユーザーにタスクの入力フィールドとして文字を入力するためのテキストボックスを表示します（通常は数語程度）。プレースホルダーフィールドには、テキストフィールドに表示されるヘルプヒントを入力します。例：刺しゅうしたい名前のタイプ。 静的ドロップダウン – エンドユーザーに選択肢のドロップダウン リストを表示します。オプションの追加をクリックして以下のパラメータでエンドユーザーに表示するアイテムのリストの追加を始まります： オプション名 – エンドユーザーに表示されるオプションの名前です。 オプション値―アプリケーションに返すオプション名という値と示します。 デフォルト値 – 1つ以上のオプションが定義されている場合、オプションのデフォルト値を選択します。 検索可能 – エンドユーザーがこのフィールドにテキストを入力するときに、ダイナミック検索と表示を有効にするか、あるいは一致がない場合に、フリーフォームのエントリを許可するかを選択します。 保存をクリックします。アイテムを追加する場合、オプションを追加をもう一度クリックします。オプションのアクション列において、オプションを編集または削除します。 動的ドロップダウン – ボット用のURLからの応答に基づいて、実行時に動的に生成されるドロップダウンリストを表示します。例：JIRAタスク通知用のプロジェクトリスト。以下の動的に配置されるドロップダウンのプロパティを定義します。 エンドポイントURL – ボットのエンドポイントURL。例：https://app.asana.com/api/1.0/workspaces。 エンドポイントのコンテンツタイプ – 指定されたエンドポイントURLから想定されるコンテンツタイプ。以下から1つ：JSON、RSS、XML、URLエンコードのJSON、CCV、文字、またはTwitter エンコードのJSON。 エンドポイントメソッド – 以下のうちの1つ： GET – [タスク]フィールドのHTTPリクエストGETメソッドを指定します。 POST – [タスク]フィールドのHTTPリクエストPOSTメソッドを指定します。 応答パス – 希望するドロップダウンリスト値を含む応答内のパス。例：データ。 ラベルキー – ドロップダウンオプションのラベルのキー。例：名前。 オプションの値キー – ドロップダウンオプションの値のキー。例：ID。 ペイロードフィールドの追加 – クリックすると、動的ドロップダウンのオプションとして、応答ペイロードから1つ以上のフィールドが追加されます。各ペイロードフィルドについて、ペイロードフィールドのキーとペイロードフィールドの値を入力し、保存をクリックします。アクション列でペイロードフィールドを編集または削除します。 検索可能 – エンドユーザーがこのフィールドにテキストを入力するときに、ダイナミック検索と表示を有効にするか、あるいは一致がない場合に、フリーフォームのエントリを許可するかを選択します。 Textarea – エンドユーザーがタスク入力としてテキスト（通常は数センテンス）を入力するためのテキストエリアボックスを表示します。プレースホルダーフィールドに、テキストボックス内でエンドユーザーに対して表示するヘルプヒントを入力します。 先行入力 – タスクに定義されたURLからの応答を基にした検索結果に一致する3つ以上の文字をユーザーが入力すると、実行時のエンドユーザーに対して動的に配置されたドロップダウンリストの選択肢が表示されます。例：JIRAのタスク通知メッセージのプロジェクトリスト。以下の動的に配置されるドロップダウンへのプロパティを定義します。 エンドポイントURL – ボットのエンドポイントURL。例：https://app.asana.com/api/1.0/workspaces。 エンドポイントのコンテンツタイプ – 指定されたエンドポイントURLから想定されるコンテンツタイプ。以下から1つ：JSON、RSS、XML、URL エンコードされた JSON、CCV、テキスト、Twitter エンコードされた JSON、Multipart/Form-data または Multipart/Related。 エンドポイントメソッド – 以下のうちの1つ： GET – [タスク]フィールドのHTTPリクエストGETメソッドを指定します。 POST – [タスク]フィールドのHTTPリクエストPOSTメソッドを指定します。 応答パス – 希望するドロップダウンリスト値を含む応答内のパス。例：データ。 ラベルキー – ドロップダウンオプションのラベルのキー。例：名前。 オプションの値キー – ドロップダウンオプションの値のキー。例：ID。 ペイロードフィールドの追加 先行入力フィールドのオプションとして、 応答ペイロードから 1 つ以上のフィールドをクリックして追加します。各先行入力のフィールドオプションについて、ペイロードフィールドのキーとペイロードフィールドの値を入力し、保存をクリックします。アクション列でペイロードフィールドを編集または削除します。 編集可能―先行入力の検索結果が一致しない場合のオプションとして、エンドユーザーがフィールドに自由にテキストを入力できるようにします。 メール – エンドユーザーがメールアドレスを入力するためのテキストボックスを表示します。プレースホルダーフィールドに、エンドユーザーに表示するヘルプヒントをテキストボックス内に入力します。 日付と時間 – エンドユーザーが日付と時間を入力するためのテキストボックスを表示します。フォーマットフィールドに、エンドユーザーに表示される日付のテキストボックスに、想定する日付や時間のフォーマットを入力します。日付フォーマットの選択 のドロップダウンリストで、日付と時間のフォーマットを選択します。 タイムゾーン―操作システムの設定に基づくタイムゾーンのドロップダウンリストを表示します。 位置―エンドユーザーが地理的位置を入力するためのテキストボックスを表示します。例：Orlando, FLまたは32801。 ネスト化フォーム – 親入力フィールドの下に、エンドユーザーの入力フィールドをネスト化形式で表示します。ネストされたフォーム入力フィールドには、次のフィールドを指定します。 配列要素型 – 親となる入力フォーム要素のデータ型を選択します。 ネスト化フォームフィールドの追加 – 1 つ以上のネスト化フォーム フィールドをクリックして追加します。 ファイル アップロード – アップロードするファイルの検索や選択ができるエンドユーザー制御を表示します。クリックして、ファイルアップロードペイロード キーを入力します。ファイルアップロードペイロードキーが定義されている場合、ファイルアップロードペイロードフィールド値のドロップダウンリストで以下のうちから1つ選択してください。 ファイル名 ファイルサイズ ファイルコンテンツタイプ
   データタイプ	ユーザー入力タイプのうちの 1 つを選択します。 文字列 – ユーザーは任意の一連の数字、文字や特殊文字を入力することができます。 数字 – ユーザーは数字を入力することができます。特殊文字は使用できません。 ブール値 – ユーザーは true または false のブール値を入力できます。 メール – ユーザーは有効なメール アドレスを入力できます。 オブジェクト – ボットからのデータは、JSONオブジェクトとして受信できます。例：次のように定義された位置の詳細として、 “location” : { “lat” : 17.4374614, “lng” : 78.4482878 } ここで、リクエストチェーンやタスクリクエストのプロパティを、 location.latおよびlocation.lngと表記します。 配列 – ユーザーは、カンマで区切った値のリストをボットに渡すことができます。例として、グーグルカレンダーでは、複数の参加者のデータのパスは: “attendees”: [“user1”, “user2”, “user3”] 選択した場合、エンドユーザーの入力の配列のタイプを以下のいずれかに指定します。 文字列 数字 ブール値 メール 配列 日付 日付―ユーザーは完全な日付を入力するか、日付の選択肢から選択することができます。
   必須	タスク設定の構成を保存するために、エンドユーザーがこの設定を定義する必要があるかどうかを選択します。

3. [詳細設定] タブをクリックして、タスク フィールドの追加のオプション設定を定義します。

フィールド名	説明
可視性	タスクの入力フィールドをエンドユーザーから見えるようにするか、見えないようにするかを指定します。可視性フィールドはカスタム設定することもできます。ここでは、データはユーザーから取得されますが、クエリパラメータやペイロードフィールドとしては使用されません。例として、JIRAボットの場合、以下のように@mentionタグを使用してチケットにコメントを投稿します。「@Mike、こちらの問題について調べてください」 JIRA APIで「コメントを投稿する」には1つのクエリフィールドおよび1つのペイロードフィールドが必須です: IDの発行 コメント 可視性フィールドをカスタムに設定すると、JIRA APIを使用して@Mikeと呼ばれるユーザーのユーザー情報をキャプチャし、データを取得してcommentフィールドの値に追加することができますが、ペイロードフィールドやクエリフィールドとしては使用できません。可視性フィールドのデフォルト設定は表示です。
キーの置き換え	Kore.ai によるキーの転置を無効にするかどうかを選択します。デフォルトでは、Kore.aiはキーと値のペアを転置します。たとえば、”parameter”:”value” はKore.aiによって “parameter:{value:”actualValue”} に転置されます。選択すると、キーは置換されません。
セッションから取得	選択すると、このフィールドのユーザー入力値をセッション変数として格納します。選択すると、[セッションからのフィールド値] のフィールドを表示します。既存の変数や [新規のセッション変数を追加] を選択して新規の変数を定義します。新規のセッション変数を作成するには、変数のスコープを選択し、変数を格納するキーを定義する必要があります。[スコープ] フィールドでは、次のうちの 1 つを選択します。 EnterpriseContext – 企業全体のユーザーに使用できるキー/値ペアを定義します。 BotContext – このボットの全ユーザーに使用できるキー/値ペアを定義します。 UserSession – 企業内のすべてのボットに対して、このユーザーが使用できるキー/値のペアを定義します。 BotUserSession – ユーザーの入力に基づいて、ボットが使用できるキー/値のペアを定義します。

• タスクリクエストのパラメータを保存して別のパラメータを追加する場合は、 追加して続行を、タスクリクエストのパラメーターを保存してダイアログを閉じる場合は追加して終了をクリックします。複数のパラメータを、ボットユーザーが入力を提供する順番で整理する必要があります。とアイコンを使用してパラメータを移動します。

タスクを実行するには、Kore.aiのセッション固有の変数を使用して、タスクを実行する前にセッションから値を入力したり、取得したりする必要があるかもしれません。詳細については、タスクでのセッション変数とコンテキスト変数の使用を参照してください。Webサービスの中には、APIリクエストを実行する前に、実行済みのコード、セッション変数、あるいはユーザーのコンテキスト詳細の変更を必要とするものがあります。例として、Webサービスでは、第1ステップとしてユーザーのログイン、第2ステップとしてパートナーの認証という2つの要素によるユーザー認証が必要となる場合があります。この2つのステップを検証した後、アクセストークンが付与され、そのWebサービスへの後続のAPIコールのヘッダーに使用されます。イニシャライザーを使用すれば、パートナー認証の完成、そしてユーザーの認証への応答からのアクセストークンを取り戻すことができます。アクセストークンはカスタムセッション変数、そして後続のAPIコールのヘッダーとしての貯蔵が可能です。

タスクイニシャライザの定義

タスクの初期化子を設定する場合、初期化子タブをクリックしてください。JavaScriptエディターが開き、必要なコードを書くことができます。 JavaScriptエディターで、以下のようにキーとスコープを定義します。

• EnterpriseContext – 企業の中のあらゆるボットとあらゆるユーザーが使用できるキー／値ペア。例として、GitHubボットの場合、ユーザーは1つ以上の企業リポジトリにアクセスする必要がます。イニシャライザでは、以下のJavaScriptコードでリポジトリデータをGitrepository（エンタープライズコンテキスト）として保持することができます。

  var userRepository = { "title": _labels_[repository], "value": repository }; EnterpriseContext.put('Gitrepository', userRepository, 200000);

• BotContext – この特定ボットのあらゆるユーザーが利用できるキー/値のペアです。例として、ユーザー所在地を拠点にしたセッションにおいて、金融取引用にデフォルトの通貨を設定することができます。イニシャライザでは、以下のJavaScriptコードによって、デフォルトの通貨データを通貨（ボットコンテキスト）として存続させることができます。

  var defaultCurrency = { TODO Custom JavaScript for location-based currency } BotContext.put('currency', defaultCurrency, 200000);

• UserContext – 企業の全ボットおよび全ユーザーが使用可能なキー/値ペアです。これらのキーは読み取り専用で、ユーザー データとしてシステムが提供します。
  • _id – Kore.aiユーザーのIDです。
  • emailId – ユーザーIDと関連するメールアドレスです。
  • lastName – ユーザーの姓です。
  • firstName – ユーザーの名です。
  • profImage – ユーザーの画像やアバター ファイル名です。
  • profColour – ユーザーアカウントの色です。
  • activationStatus – ユーザーのアカウントステータスです。
  • title – ユーザーのタイトルです。(定義されている場合)
  • orgId – ユーザーアカウントの組織IDです(定義されている場合)。
• UserSession – 企業内のすべてのボットに対して、特定ユーザーが利用できるキー/値のペアを定義します。例として、商取引、輸送、宅配便サービスのためのユーザーの自宅住所など、ユーザーの位置を保存して全ボットにも利用できるようにしたい場合もあります。イニシャライザでは、以下のJavaScriptコードによって、デフォルトの位置データをHomeLocation (UserSession)として存続させることができます。

  var location = { "title": labels[location], "value": { "latitude": location.latitude, "longitude": request.location.longitude } }; UserSession.put('HomeLocation', location, '20000');

• BotUserSession – 特定のユーザーの入力に基づいて、特定のボットに使用できるキー・値のペアを定義します。例として、 複数のボットタスクにとってユーザー位置を存続させたい場合もあります。旅行ボットの場合、ユーザーは同じ自宅と目的地の住所に基づいてフライトとホテルを予約できる場合があります。イニシャライザでは、以下のJavaScriptコードによって、デフォルトの自宅と宛先のデータを、HomeLocation（BotUserSession ）およびDestinationLocation（BotUserSession ）として存続させることができます。

  var homelocation = { "title": labels[request.sourceLocation], "value": { "latitude": request.sourceLocation.latitude, "longitude": request.sourceLocation.longitude } }; BotUserSession.put('HomeLocation', homelocation, '20000'); var destlocation = { "title": labels[request.destLocation], "value": { "latitude": request.destLocation.latitude, "longitude": request.destLocation.longitude } }; BotUserSession.put('DestinationLocation', destlocation, '20000’);

GETとPUT構文

以下のコードの例は、各コンテキストタイプのキー値ペアをＧＥＴまたはPUTする構文を表示します。

"EnterpriseContext" : { "get" : function(key){...},//get the specified key "put" : function(key, value, ttl){...}//put the value at the key for the specified ttl, ttl is in minutes }, "BotContext" : { "get" : function(key){...},//get the specified key "put" : function(key, value, ttl){...}//put the value at the key for the specified ttl, ttl is in minutes }, "UserContext" : { "get" : function(key){...},//get the specified key }, "UserSession" : { "get" : function(key){...},//get the specified key "put" : function(key, value, ttl){...}//put the value at the key for the specified ttl, ttl is in minutes }, "BotUserSession" : { "get" : function(key){...},//get the specified key "put" : function(key, value, ttl){...}//put the value at the key for the specified ttl, ttl is in minutes }

例：

BotContext.put("topicSessionVariable","music",2000); UserSession.put("firstName","Mary",20000); UserContext.get("firstName");

Exception Syntax

また、タスクを設定する前に、認証失敗などのエラーを捕捉するためのカスタムエラーメッセージを定義することもできます。例外をキャプチャした場合、タスクの設置は中止します。以下の構文を使用して例外を外します。

{ "exceptions": { "message": " Error Message" } }

例：

var ex ={}; var exceptions={}; exceptions.message ='You can not proceed further with out valid permissions'; ex.exceptions = exceptions; print(JSON.stringify(ex)); //print is mandatory.

イニシャライザセクションでは、セッションキーまたはその他のセッション変数を使用することができますが、値を設定またはアクセスすることはできません。例：

var name = UserContext.get("firstName")+UserContext.get("lastName"); UserSession.put("fullName") = name;

先行コードの例では、タスクの詳細設定セクションのセッションから取得フィールドで定義されたタスクのパラメータを使用して、値をセッションに入力します。キーは、カスタム定義されたUserSessionコンテキスト変数のfullNameとして定義されます。

タスク初期化子の例

以下のコードは、タスクの初期化子でAPIリクエストに変数を先行発生するユーザーIDおよびメールのデータを取得する例です。

var x = UserContext.get("identities"); var isEmailFound = false; for (var i = 0; i < x.length; i++) { if (x[i].type === "mapped") { var identity = x[i].val var arr = identity.split("/"); var pattern = /^cs/i; var result = arr[0].match(pattern); if (result) { isEmailFound = true; UserSession.put("rtmEmail", arr[1], '20000'); } } } if (!isEmailFound) { for (var j = 0; j < x.length; j++) { if (x[j].type === "email") { UserSession.put("rtmEmail", x[j].val, '20000'); } } }

「APIリクエスト」タブの「リクエスト」セクションでは、プリプロセッサ、APIリクエスト、ポストプロセッサで構成されるAPIリクエストチェーンを定義することができます。少なくとも1つのAPIリクエストが必要ですが、プロセッサはオプションです。

APIリクエスト

あらゆるタスクにも、APIリクエストを定義してからWebサービスへのコールでタスクを開始することができます。少なくとも各タスクに1点のAPIリクエストが必須です。各APIリクエストについては、必ず1つ以上のリクエストURLs、およびWebサービスからのデータペイロード転送を開始するためのタスクへのパスを追加する必要があります。

APIリクエストの設定

1. APIリクエストタブで、リクエストタブを展開し、APIの追加をクリックします。
2. 以下の手順の説明に従って、APIの追加ダイアログのフィールドの値を指定します。
3. 名前フィールドに、たとえばマイAPIリクエストのように、APIリクエストの名前を入力します。
4. メソッドドロップダウンリストで、タスクに使用するHTTPメソッドを選択します。以下から1つ：
   • POST―顧客情報やファイルのアップロード、HTMLフォームの使用など、サーバーにデータを送信するために使用します。
   • PUT– ターゲットリソースのコンテンツを、送信されてきたコンテンツに置き換えます。
   • PATCH – 送信されてきたコンテンツに、既存のターゲットリソースのコンテンツを追加します。
   • DELETE―既存のターゲットリソースのコンテンツを削除します。
   • GET―既存のターゲットリソースのコンテンツを返します。
5. URLフィールドには、ボットタスクのレスポンスを処理するためのURLを指定します。例：http://koremessenger.com/postURL。次の例のように、URLにセッション変数を使用することもできます。

   https://mySite.crm.ondemand.com/sap/c4c/odata/v1/c4codata/ServiceRequestCollection?$filter=ID eq '{id}' and ReporterEmail eq '{userEmail}'&$expand=ServiceRequestHistoricalVersion,ServiceRequestDescription

   メモ：URLによっては、 エンド パラメータとスタート パラメーターにKore.ai独自のパラメーター値を使用したいこともあります。Kore.aiのパラメータ値の詳細については、ボットの追加にあるボット固有のドキュメントをご参照ください。
6. コネクタを使用したアクセスフィールドで、はいを選択し、Kore.aiコネクタエージェントを使用してKore.ai ボットへのアクセスを有効にします。このオプションは、Kore.ai コネクタ エージェントが企業の社内ネットワークで構成、有効化されている場合に表示されます。詳細については、Kore.ai Connectorの使用をご覧ください。
7. ヘッダータブのコンテンツタイプフィールドで、サンプル応答データに以下のサポートされているデータタイプのいずれかを選択します。
   • JSON – JavaScriptオブジェクトノテーションは、人間が読めるテキストを使用して、データオブジェクトを属性と値のペアとして送信するオープンスタンダードなフォーマットです。Kore.aiサーバーとボットWebアプリケーションとの間のデータ転送には、JSONを使用することができます。
   • RSS – リッチサイトサマリーあるいはリアリーシンプルシンジケーションは、ブログエントリ、ニュースヘッドライン、音声、ビデオなど、頻繁に更新される情報を公開するために使用される標準化されたフォーマットの一種です。
   • XML – 拡張可能なマークアップ言語は、人間が読むことも、機械が読むこともできる形式でドキュメントをエンコードするための一連のルールを定義するマークアップ言語です。WebサービスがXMLデータを処理するのに、XMLスキーマがよく使用されます。
   • URL エンコードされたJSON – 予約文字のためにJSON のエンコードを使用するURL。
   • CSV – カンマ区切りの値のリスト。
   • 文字―テキストベースのキー値ペア。
   • Twitter エンコードされた JSON – 予約文字のためにJSONのエンコードを使用したTwitterのURL。
   • マルチパート/フォームデータ – ユーザーがフォームからファイルをアップロードできるようにしたい場合に、HTTP POSTリクエストメソッドでファイルを送信するためのエンコーディングタイプ。
   • マルチパート/関連品 – 同じ情報を、他のフォームの他のボディパーツで表示する場合に使用。ボディ パーツは複雑度の高い順に並べられています。
   • Oracle ADF – Oracle Application Development Framework に使用します。
8. [認証ヘッダー] セクションで、次の図に示すようにヘッダーのキーを有効化または無効化します。
9. パラメータ タブでは、下図のように 認証パラメータやヘッダーに含めるパラメータを選択またはクリアします。
10. 保存をクリックしてAPIリクエストの設定を保存して閉めます。

プロセッサ

プロセッサでJavaScriptを使用してWebサービスへのAPIリクエストの前、途中、または後で、ユーザーセッションで収集されたマルチデータを操作することができます。プロセッサをAPIリクエストの前に定義して取り付ける場合、それはプリプロセッサーになります。プリプロセッサーはAPIリクエストの実行の前にセッションの変数から入力のパラメータと値の管理を可能にします。そのプロセッサはAPIリクエストの後に順次取り付けられた場合、ポストプロセッサとなります。ポストプロセッサを使用して、APIリクエストからペイロード応答キーにアクセスできます。キーにアクセスするには、以下のいずれかのポストプロセッサタイプを使用します。

• 解決：キーにアクセスするには、次のいずれかのポストプロセッサタイプを使用します。
• 展開 – ペイロードにあるデータ文字列を分ける。
• 抽出 – 複数のオブジェクトを持つペイロードにおいて、特定のオブジェクトへのパスを指定する。
• 割り当て – ペイロード応答の変数名を指定する。

プリプロセッサ

APIリクエストが実行される前に、プリプロセッサを使用して、セッション変数とパラメータでリクエストパラメータを管理することができます。プリプロセッサを定義する際には、処理のタイプをカスタム に設定し、表示されるJavaScriptエディターにコードを入力する必要があります。プリプロセッサは、カスタムタイプのみとなります。

プリプロセッサの追加

1. APIリクエストページで、リクエストタブを展開し、プロセッサを追加をクリックします。
2. 名前フィールドにプロセッサの名前を入力します。
3. プロセッサのタイプドロップダウンリストで、プリプロセッサにカスタムを選択する必要があります。
4. 必要に応じて、以下の構文でリクエストパラメータを操作するコードを追加します。

   { "fields": { "payloadFields": { // to set value to a payload field "key1": "value1", // Payload fields are not applicable for Alert tasks."key2": "value2"....}, "headerFields": { // to set value to a header field "key1": "value1", "key2": "value2"....}, "pathFields": { // to set value to a path field or query field."key1": "value1", "key2": "value2"....} } }

   例として、次のコードスニペットは、APIオブジェクトのパスフィールドまたはクエリフィールドを設定するために使用できます。

   var fields= {}; var pathFields = {}; pathFields.fullName = UserContext.get("firstName")+UserContext.get("lastName") fields.pathFields = pathFields; var finalObject = {}; finalObject.fields = fields; print(JSON.stringify(finalObject));

   当該コードに、firstNameおよびlastNameがセッション変数として保存されていてJohnおよびSmithがそれぞれに対応している場合、プリプロセッサからの JSON ペイロード応答は次のようになります。

   { fields: { "pathFields": { "key": "fullName", "value": "John Smith" } } }

   下記のキー値ペアーの例では、実のAPIリクエストコールの先に変数はセッション変数に設定されます。

   var fields = {}; var pathFields = {}; var UserEmailID = UserSession.get("rtmEmail"); pathFields.userEmail = UserEmailID; fields.pathFields = pathFields; var finalObject = {}; finalObject.fields = fields; print(JSON.stringify(finalObject));

5. 保存 をクリックして、プロセッサの追加ダイアログを保存して閉じます。

ポストプロセッサの追加

ご使用のWebサービスから1点以上のAPIリクエストで、Kore.aiポストプロセッサを使用してお望みのデータペイロードを取得することもあります。

カスタムポストプロセッサの定義

カスタムポストプロセッサを作成したい場合、以下の構文を使用して前のAPIリクエストの応答キーにアクセスできます。

payload[0].{ key }

JSON Syntax

{ "payload": { "key1" : "value1", "key2" : "value2" } }

例

var final = {}; var data = payload[0]; //Accessing the response of the previous API object data.title[0] = 'New value for key here'; final.payload = data; // Updating the response of the API object print(JSON.stringify(final)); // This step is mandatory

カスタムプロセッサの場合、前のコードで示されたように、最後の応答を示した先行コードとして印刷してください。そうでなければ、空の応答が返されます。以下の構文を使用します。

print(JSON.stringify( <<object>> ));

標準ポストプロセッサの設定

以下の手順で、標準ポストプロセッサを追加します。

1. APIリクエストタブで、リクエストタブを展開し、プロセッサの追加をクリックします。
2. Kore.aiは、ポストプロセッサ用のカスタムコードを作成する代わりに、使用できる標準ポストプロセッサのセットを提供します。処理のタイプフィールドに、以下の4つの標準プロセッサのタイプのうちの1つを選択します：
   1. 解決：1つのペイロード応答の結果を、2つ目のリクエストの入力として使用することができます。例として、プロセッサを追加をクリックして、プロセッサの名前を入力し、プロセッサのタイプを解決に、キーを変数の名前に設定し、最初のAPIリクエストからの変数を使用して投稿URLを定義します。For example, https://app.asana.com/api/1.0/projects/{project_id} that returns the id field in the payload response as:

      ..."id":80468818418144, <br/> "created_at":"2016-01-14T05:34:35.848Z", "modified_at":"2016-01-20T04:29:52.505Z", "owner":{ "id":73114591129714, "name":"jaganmohan.evuri" }, ...

      それは次に変数入力として下記のPost URLのように: https://app.asana.com/api/1.0/projects/{id}/tasks?opt_fields=completed,modified_at また、ペイロードレスポンスで想定されるHTML コンテンツタ イプとHTML リクエス トメソッドも指定する必要があります。詳細については、タスクでのセッション変数とコンテキスト変数の使用を参照してください。

   2. 展開：分けとするデータが含む文字列のペイロードの場合。例として、プロセッサを追加をクリックし、プロセッサの名前を入力し、キーフィールドをデータなどに設定し、プロセッサタイプを展開に設定して、以下のコード例でdata要素の内容を取り込み、配列の各アイテムを抽出します。

      { "attribution": null, "tags": [], "type": "image", "location": null, "comments": { "count": 51, "data": [{ "created_time": "1453900980", "text": "43rd", "from": { "username": "kore_hyd", "profile_picture": "https://scontent.cdninstagram.com/t51.2885-19/11906329_960233084022564_1448528159_a.jpg", "id": "2056218675", "full_name": "Kore.ai Hyd" }, "id": "1171728804843572377" }, { "created_time": "1453901222", "text": "44th", "from": { "username": "kore_hyd", "profile_picture": "https://scontent.cdninstagram.com/t51.2885-19/11906329_960233084022564_1448528159_a.jpg", "id": "2056218675", "full_name": "Kore.ai Hyd" }, "id": "1171730841379491107" }, { "created_time": "1453901997", "text": "45th", "from": { "username": "kore_hyd", "profile_picture": "https://scontent.cdninstagram.com/t51.2885-19/11906329_960233084022564_1448528159_a.jpg", "id": "2056218675", "full_name": "Kore.ai Hyd" }, "id": "1171737339782450909" }, { "created_time": "1453902304", "text": "46th and 47th", "from": { "username": "kore_hyd", "profile_picture": "https://scontent.cdninstagram.com/t51.2885-19/11906329_960233084022564_1448528159_a.jpg", "id": "2056218675", "full_name": "Kore.ai Hyd" }, "id": "1171739915923967873" }, { "created_time": "1453902638", "text": "48th", "from": { "username": "kore_hyd", "profile_picture": "https://scontent.cdninstagram.com/t51.2885-19/11906329_960233084022564_1448528159_a.jpg", "id": "2056218675", "full_name": "Kore.ai Hyd" }, "id": "1171742713994497101" }, { "created_time": "1453964684", "text": "49th", "from": { "username": "venkataphani.ailavarapu", "profile_picture": "https://scontent.cdninstagram.com/t51.2885-19/11906329_960233084022564_1448528159_a.jpg", "id": "2679234818", "full_name": "Phani" }, "id": "1172263199715314941" }, { "created_time": "1453964710", "text": "50th", "from": { "username": "kore_hyd", "profile_picture": "https://scontent.cdninstagram.com/t51.2885-19/11906329_960233084022564_1448528159_a.jpg", "id": "2056218675", "full_name": "Kore.ai Hyd" }, "id": "1172263415747136776" }, { "created_time": "1453964717", "text": "51st", "from": { "username": "kore_hyd", "profile_picture": "https://scontent.cdninstagram.com/t51.2885-19/11906329_960233084022564_1448528159_a.jpg", "id": "2056218675", "full_name": "Kore.ai Hyd" }, "id": "1172263474056350986" }] ...

   3. 抽出：複数オブジェクトが含むペイロードの場合、特定のオブジェクトにパスを指定することができます。例として、プロセッサの追加をクリックし、プロセッサの名前を入力し、キーフィールドをdataに設定し、抽出する処理のタイプを選択して、次のペイロード応答でオブジェクトデータを使用します。

      { "user": { "full_name": "Kore.ai Hyd", "id": "2056218675", "profile_picture": "https://instagramimages-a.akamaihd.net/profiles/anonymousUser.jpg", "username": "kore_hyd" }, ...}, "likes": { "data": [{ "full_name": "kstream002", "id": "2100724876", "profile_picture": "https://instagramimages-a.akamaihd.net/profiles/anonymousUser.jpg", "username": "kstream002" } }, ...}

   4. 割り当て：割り当て プロセッサを使用すると、ペイロードにペイロード応答データのキーが含まれていない場合など、必要に応じて、ペイロード応答の変数名を指定することができます。例として、処理のタイプを割り当てに設定し、アウトプット変数フィールドで、たとえば、次のようなペイロードに対して、3つのオブジェクトの配列であるアウトプット変数を定義することができます。

      [ { "Cost": "$0.00", "Desc1": "$150 bonus after $500 of purchases in the first 3 months from account opening.", "Desc2": "Earn unlimited cash back Earn unlimited 1.5% cash back on every purchase – it's automatic.Redeem for cash back – any amount, any time.", "Keywords": "weekend dining,online,groceries,fuel,rewards,rebate,365,allaround", "OfferName": "Freedom Unlimited", "OfferType": "CreditCard", "Status": "1", "imageURL": "http://www.psdgraphics.com/file/credit-card.jpg", "id": "5b5195e264bbd800" }, { "Cost": "$95.00", "Desc1": "Pay 0 balance transfer fee when you transfer a balance during the first 60 days.", "Desc2": "Jumpstart your financial fitness Get an introductory fee for balance transfers, save on interest†, and get your free monthly credit score.", "Keywords": "privileges,rebate,health,wellness,great eastern,insurance,policy,installments,split,cashflo", "OfferName": "Premium Plus", "OfferType": "CreditCard", "Status": "1", "imageURL": "http://i.imgur.com/rMOXYql.jpg", "id": "5caf2155873f89c8" }, { "Cost": "$10.00", "Desc1": "Pay 0 balance transfer fee when you transfer a balance during the first 60 days.", "Desc2": "Jumpstart your financial fitness Get an introductory fee for balance transfers, save on interest†, and get your free monthly credit score.", "Keywords": "privileges,rebate,health,wellness,great eastern,insurance,policy,installments,split,cashflo", "OfferName": "Frequent Flyer", "OfferType": "CreditCard", "Status": "1", "imageURL": "http://www.moneychoice.org/wp-content/uploads/sites/30/2016/01/credit-card-calculator-image.png.jpeg", "id": "c0b05bc3062658ee" } ]

      アウトプット変数フィールドには、たとえば、配列を表す変数を offersのように指定します。もしUXプレビュー機能を使用した場合、Kore.ai からの応答は以下の通りです。

      { "response": { "offers": [ { "Cost": "$0.00", "Desc1": "$150 bonus after $500 of purchases in the first 3 months from account opening.", "Desc2": "Earn unlimited cash back Earn unlimited 1.5% cash back on every purchase – it's automatic.Redeem for cash back – any amount, any time.", "Keywords": "weekend dining,online,groceries,fuel,rewards,rebate,365,allaround", "OfferName": "Freedom Unlimited", "OfferType": "CreditCard", "Status": "1", "imageURL": "http://www.psdgraphics.com/file/credit-card.jpg", "id": "5b5195e264bbd800" }, { "Cost": "$95.00", "Desc1": "Pay 0 balance transfer fee when you transfer a balance during the first 60 days.", "Desc2": "Jumpstart your financial fitness Get an introductory fee for balance transfers, save on interest†, and get your free monthly credit score.", "Keywords": "privileges,rebate,health,wellness,great eastern,insurance,policy,installments,split,cashflo", "OfferName": "Premium Plus", "OfferType": "CreditCard", "Status": "1", "imageURL": "http://vignette3.wikia.nocookie.net/objectmayhem/images/5/52/Credit_card.png/revision/latest?cb=20130629150408", "id": "5caf2155873f89c8" } ] } }

      アウトプット変数がoffersに設定されていると、ボットビルダーでresponse.offers として、たとえば、以下のようにタスク応答オブジェクトで使用することができます。

      print(JSON.stringify(response)); var data = response.offers for (i = 0; i < data.length; i++) { print('<a href="' + data[i].imageURL + '" target="_blank">' + data[i].OfferName + '</a><br>'); print(data[i].Desc1) print('<br>'); print('<br>'); print('Cost: ' + data[i].Cost) print('<br>'); if (i < data.length - 1) { print('<br>'); print('<br>'); } }

3. 追加をクリックしてAPIリクエストを保存してから別のAPIリクエストを作成するか、追加と終了をクリックしてAPIリクエストを保存してからダイアログをクローズ閉じます。

複数のAPIリクエストの場合、リクエストをシーケンシャルの並べで並べ直してから全体のデータ応答を取得するようにしてください。例として、ワークスペースのリストを依頼し、次にプロジェクトのリストを依頼し、最後にユーザーのリストを依頼する必要があるかもしれません。繰り上げ アイコンと繰り下げ アイコンを使用して、APIリクエストの順番を入れ替えます。

応答サンプルセクションでは、タスクのペイロードで受信することが想定されるキーと値のペアのサンプルを入力または貼り付けることができます。応答サンプルを定義すると、応答サンプルセクションで指定したキーが、アウトプットデータを処理するために、ドロップダウンの選択肢として利用できます。

サンプル応答の追加

1. API リクエストタブで、サンプル応答セクションを展開します。
2. JSON応答のペイロードのキーと値の組み合わせを含む応答サンプルを入力します。以下のいずれかを実行します。
   • 次の図のように、応答のビューをインデント付きのJSON構造としてフォーマットするには、フォーマット済み アイコンをクリックします。
   • 応答のビューをシリアルナンバーが付けられたコンパクトなフォームでフォーマット化するには、下図のとおりに、フォーマット化されていないアイコンをクリックします。

Kore.aiのアクションタスクのリクエストで、および接続モードがSOAPに設定されている場合、以下のように定義する必要があります。

• 認証 – アクションタスクに必要な場合、APIにアクセスするための認証を定義する必要があります。たとえば、基本認証、OAuth、またはAPIキーを使用します。詳細は、APIリクエストタブ – 認証設定をご覧ください。
• WSDL URL – WSDLデータを含むURLを定義します。URLを取得すると、WSDLを基にして利用できる操作リストから選択し、ユーザー入力フィールドをカスタマイズすることができます。詳細は、WSDL URLの定義をご覧ください。
• コネクタを使用したアクセス -ボットプラットフォームがオンプレミスでインストールされていて、Kore.aiコネクタのエージェントを使用したい場合に指定します。詳細は、コネクタを使用したアクセスをご覧ください。
• 応答サンプル – アクションタスクのペイロードで受信すると想定されるキー/値のペアを定義します。提供したキー・値のペアは、エンドユーザーに表示するデータの処理用として、ドロップダウンの選択肢として使用できます。詳細は、アクションタスクに応答サンプルを追加をご覧ください。

1. API リクエストタブで、WSDL URLセクションを展開します。
2. SOAPリクエストのリクエストタスクの設定を開始するには、WSDL URL フィールドにSOAP WSDLのURLを入力します。
3. WSDLの説明を手に入れるをクリックします。WSDLにおいて定義されている 使用可能な演算子 のリストが開きます。
4. タスクで使用するSOAPリクエストの選択をクリックします。Kore.aiは、ユーザー入力が必要な場合、1つ以上の[アクションタスク]フィールドを自動的に入力します。

[SOAPアクションタスク]フィールドのカスタマイズ

WSDLから使用可能なオペレーション を1つ以上選択した後、Kore.aiが提供するデフォルトの入力フィールドをカスタマイズすることができます。デフォルトの[アクションタスク]フィールドをカスタマイズするには、以下の手順に従います。

1. カスタマイズしたいアクションタスクフィールドの編集をクリックします。アクションタスクフィールドのセットアップダイアログが開きます。
2. 入力を収集するエンドユーザーフィールドを定義するには、次のテーブルに説明されているように、アクションタスクフィールドのセットアップダイアログでパラメータの値を指定します。
   

   フィールド名	説明
   フィールド タイトル	エンドユーザーインターフェースに表示されるタスク入力フィールドのタイトル。例： 国。
   ヘルプのヒント	ヘルプテキストはタスクの下に表示されています。そのタスクは、たとえば「天気を知りたい国の名前を入力する」というタスクを説明するタイトルを設定することです。
   フィールドキー	収集するエンドユーザーの入力値を表す、読み取り専用キーです。例:国.
   フィールドタイプ	キーの値に割り当てるリクエストオブジェクト用のユーザー入力を収集するためにエンドユーザーインターフェースに表示されるタスク入力フィールドのタイプを指定します。デフォルト設定はテキストボックスですが、以下のいずれか1つをカスタマイズできます。 日付 – フォーマットフィールドが表示され、エンドユーザーが自分のアカウントにタスクが設定される際に定義する日付フォーマットの構文を選択できます。日付フォーマット選択のドロップダウン リストから、次のうちの1つを選択します。 dd-MM-YYYY – 例:16-05-1999 MM-dd-YYYY – 例:05-16-1999 dd-MM-YY – 例:16-05-99 YYYY-MM-dd – 例:1999-05-16 URL – 正しい URL 構文のためのフィールド検証を含む、エンドユーザーによる URL 入力用のテキスト ボックスを表示します。プレースホルダーフィールドには、テキストボックスに表示されるヘルプヒントを入力します。例：こちらにWebサイトのURLを入力してください。 テキストボックス―エンドユーザーにタスクの入力フィールドとして文字を入力するためのテキストボックスを表示します（通常は数語程度）。プレースホルダーフィールドには、テキストフィールドに表示されるヘルプヒントを入力します。例：刺しゅうしたい名前のタイプ。 静的ドロップダウン – エンドユーザーに選択肢のドロップダウン リストを表示します。オプションの追加をクリックして以下のパラメータでエンドユーザーに表示するアイテムのリストの追加を始まります： オプション名 – エンドユーザーに表示されるオプションの名前です。 オプション値―アプリケーションに返すオプション名という値と示します。 デフォルト値 – 1つ以上のオプションが定義されている場合、オプションのデフォルト値を選択します。 検索可能 – エンドユーザーがこのフィールドにテキストを入力するときに、ダイナミック検索と表示を有効にするか、あるいは一致がない場合に、フリーフォームのエントリを許可するかを選択します。 保存をクリックします。アイテムを追加する場合、オプションを追加をもう一度クリックします。オプションのアクション列において、オプションを編集または削除します。 動的ドロップダウン – ボット用のURLからの応答に基づいて、実行時に動的に生成されるドロップダウンリストを表示します。例：JIRAタスク通知用のプロジェクトリスト。以下の動的に配置されるドロップダウンのプロパティを定義します。 エンドポイントURL – ボットのエンドポイントURL。例：https://app.asana.com/api/1.0/workspaces。 エンドポイントのコンテンツタイプ – 指定されたエンドポイントURLから想定されるコンテンツタイプ。以下から1つ：JSON、RSS、XML、URLエンコードのJSON、CCV、文字、またはTwitter エンコードのJSON。 エンドポイントメソッド – 以下のうちの1つ： GET – [タスク]フィールドのHTTPリクエストGETメソッドを指定します。 POST – [タスク]フィールドのHTTPリクエストPOSTメソッドを指定します。 応答パス – 希望するドロップダウンリスト値を含む応答内のパス。例：データ。 ラベルキー – ドロップダウンオプションのラベルのキー。例：名前。 オプションの値キー – ドロップダウンオプションの値のキー。例：ID。 ペイロードフィールドの追加 – クリックすると、動的ドロップダウンのオプションとして、応答ペイロードから1つ以上のフィールドが追加されます。各ペイロードフィルドについて、ペイロードフィールドのキーとペイロードフィールドの値を入力し、保存をクリックします。アクション列でペイロードフィールドを編集または削除します。 検索可能 – エンドユーザーがこのフィールドにテキストを入力するときに、ダイナミック検索と表示を有効にするか、あるいは一致がない場合に、フリーフォームのエントリを許可するかを選択します。 Textarea – エンドユーザーがタスク入力としてテキスト（通常は数センテンス）を入力するためのテキストエリアボックスを表示します。プレースホルダーフィールドに、テキストボックス内でエンドユーザーに対して表示するヘルプヒントを入力します。 先行入力 – タスクに定義されたURLからの応答を基にした検索結果に一致する3つ以上の文字をユーザーが入力すると、実行時のエンドユーザーに対して動的に配置されたドロップダウンリストの選択肢が表示されます。例：JIRAのタスク通知メッセージのプロジェクトリスト。以下の動的に配置されるドロップダウンへのプロパティを定義します。 エンドポイントURL – ボットのエンドポイントURL。例：https://app.asana.com/api/1.0/workspaces。 エンドポイントのコンテンツタイプ – 指定されたエンドポイントURLから想定されるコンテンツタイプ。以下から1つ：JSON、RSS、XML、URL エンコードされた JSON、CCV、テキスト、Twitter エンコードされた JSON、Multipart/Form-data または Multipart/Related。 エンドポイントメソッド – 以下のうちの1つ： GET – [タスク]フィールドのHTTPリクエストGETメソッドを指定します。 POST – [タスク]フィールドのHTTPリクエストPOSTメソッドを指定します。 応答パス – 希望するドロップダウンリスト値を含む応答内のパス。例：データ。 ラベルキー – ドロップダウンオプションのラベルのキー。例：名前。 オプションの値キー – ドロップダウンオプションの値のキー。例：ID。 ペイロードフィールドの追加 先行入力フィールドのオプションとして、 応答ペイロードから 1 つ以上のフィールドをクリックして追加します。各先行入力のフィールドオプションについて、ペイロードフィールドのキーとペイロードフィールドの値を入力し、保存をクリックします。アクション列でペイロードフィールドを編集または削除します。 編集可能―先行入力の検索結果が一致しない場合のオプションとして、エンドユーザーがフィールドに自由にテキストを入力できるようにします。 メール – エンドユーザーがメールアドレスを入力するためのテキストボックスを表示します。プレースホルダーフィールドに、エンドユーザーに表示するヘルプヒントをテキストボックス内に入力します。 日付と時間 – エンドユーザーが日付と時間を入力するためのテキストボックスを表示します。フォーマットフィールドに、エンドユーザーに表示される日付のテキストボックスに、想定する日付や時間のフォーマットを入力します。日付フォーマットの選択 のドロップダウンリストで、日付と時間のフォーマットを選択します。 タイムゾーン―操作システムの設定に基づくタイムゾーンのドロップダウンリストを表示します。 位置―エンドユーザーが地理的位置を入力するためのテキストボックスを表示します。例：Orlando, FLまたは32801。 ネスト化フォーム – 親入力フィールドの下に、エンドユーザーの入力フィールドをネスト化形式で表示します。ネストされたフォーム入力フィールドには、次のフィールドを指定します。 配列要素型 – 親となる入力フォーム要素のデータ型を選択します。 ネスト化フォームフィールドの追加 – 1 つ以上のネスト化フォーム フィールドをクリックして追加します。 ファイル アップロード – アップロードするファイルの検索や選択ができるエンドユーザー制御を表示します。クリックして、ファイルアップロードペイロード キーを入力します。ファイルアップロードペイロードキーが定義されている場合、ファイルアップロードペイロードフィールド値のドロップダウンリストで以下のうちから1つ選択してください。 ファイル名 ファイルサイズ ファイルコンテンツタイプ
   データタイプ	ユーザー入力タイプのうちの 1 つを選択します。 文字列 – ユーザーは任意の一連の数字、文字や特殊文字を入力することができます。 数字 – ユーザーは数字を入力することができます。特殊文字は使用できません。 ブール値 – ユーザーは true または false のブール値を入力できます。 メール – ユーザーは有効なメール アドレスを入力できます。 オブジェクト – ボットからのデータは、JSONオブジェクトとして受信できます。例：次のように定義された位置の詳細として、 “location” : { “lat” : 17.4374614, “lng” : 78.4482878 } ここで、リクエストチェーンやタスクリクエストのプロパティを、 location.latおよびlocation.lngと表記します。 配列 – ユーザーは、カンマで区切った値のリストをボットに渡すことができます。例として、グーグルカレンダーでは、複数の参加者のデータのパスは: “attendees”: [“user1”, “user2”, “user3”] 選択した場合、エンドユーザーの入力の配列のタイプを以下のいずれかに指定します。 文字列 数字 ブール値 メール 配列 日付 日付―ユーザーは完全な日付を入力するか、日付の選択肢から選択することができます。
   プレースホルダ	入力テキストボックスの下に表示されるテキストで、ユーザーがフィールドを定義するのに役立ちます。このフィールドは特定のフィールド タイプに表示されます。
   可視性	タスクの入力フィールドをエンドユーザーから見えるようにするか、見えないようにするかを指定します。可視性フィールドはカスタムフィールドに設定することもできます。ここでは、データはユーザーから取得されますが、クエリパラメータやペイロードフィールドとしては使用されません。例として、JIRAボットの場合、以下のように@mentionタグを使用してチケットにコメントを投稿します。「@Mike、こちらの問題について調べてください」 JIRA APIでコメントを投稿するには1つのクエリフィールドおよび1つのペイロードフィールドが必須です: IDの発行 コメント 可視性フィールドをカスタムに設定すると、JIRA APIを使用して@Mikeと呼ばれるユーザーのユーザー情報をキャプチャし、データを取得してcommentフィールドの値に追加することができますが、ペイロードフィールドやクエリフィールドとしては使用できません。可視性フィールドのデフォルト設定は表示です。
   必須	タスク設定の構成を保存するために、エンドユーザーがこの設定を定義する必要があるかどうかを選択します。
   キーの置き換え	Kore.ai によるキーの転置を無効にするかどうかを選択します。デフォルト設定では、Kore.ai ははキー/値のペアを置換します。たとえば、"parameter":"value"は Kore.ai によって "parameter:{value:"actualValue"}に置換されます。このオプションを選択すると、キーはKore.aiによって転置されず、受信した応答として渡されます。

3. 追加して続行をクリックすると、[タスク]フィールドが保存され、別の アクションタスクフィールドが作成されます。あるいは、追加して終了をクリックして、アクションタスクフィールドを保存してからダイアログを閉じます。

タスクにコネクタを使用してアクセスを定義することを始めるには、以下の手順に従います。

1. API リクエストのタブから、コネクタでアクセスセクションを開きます。
2. コネクタを使用したアクセスフィールドで、はいを選択し、Kore.aiコネクタエージェントを使用してKore.ai ボットへのアクセスを有効にします。このオプションは、Kore.ai コネクタ エージェントが企業の社内ネットワークで構成、有効化されている場合に表示されます。詳細については、Kore.ai Connectorの使用をご覧ください。

応答サンプルセクションでは、タスクのペイロードで受信することが想定されるキー・値のペアのサンプルを入力または貼り付けることができます。応答サンプルを定義すると、応答サンプルセクションで指定したキーが、アウトプットデータを処理するために、ドロップダウンの選択肢として利用できます。

サンプル応答の追加

1. API リクエストタブで、サンプル応答セクションを展開します。
2. JSON応答のペイロードのキーと値の組み合わせを含む応答サンプルを入力します。以下のいずれかを実行します。
   • 次の図のように、応答のビューをインデント付きのJSON構造としてフォーマットするには、フォーマット済み アイコンをクリックします。
   • 応答のビューをシリアルナンバーが付けられたコンパクトなフォームでフォーマット化するには、下図のとおりに、フォーマット化されていないアイコンをクリックします。