API ワークフローを構築する

link

新しい API ワークフロー プロジェクトを作成する​

• ソリューション名: Monster Query - 5e SRD
• ワークフロー名: API Query - 5e Monsters

入力と出力を設定する​

HTTP 要求を追加する​

1. ワークフロー キャンバスで、アクティビティ間で [+ ] を選択してアクティビティ メニューを開きます。[ HTTP] を選択します。このアクティビティは、キャンバスに [HTTP 要求] として表示されます。
2. アクティビティのコンテキスト メニューを開き、[ 名前を変更] を選択します。と HTTP Request - Open5e Monster Query名前を付けます。
3. [ プロパティ] ペインで、[ Authentication ] が [Manual authentication ] で、[ Method ] が [GET] であることを確認します。どちらも新しいアクティビティの既定値であるため、通常は変更する必要はありません。
4. [ URL ] を https://api.open5e.com/v2/creatures/に設定します。
5. アクティビティの出力の名前を searchResultsに変更します。

• name__icontains: 大文字と小文字を区別しない部分一致。 dragon が「大人の赤龍」「若き青龍」他に帰ってくる
• document__key: srd-2014: 公式の 5e SRD へのフィルター。これがない場合、結果にはデータベース内のすべてのパブリッシャーが含まれ、サードパーティのコンテンツが含まれます
• limit: 10: 候補者の上限は 10 人。エージェントがコンテキストを氾濫させることなく推論を行うのに十分である
• fields: 応答をエージェントが必要とするフィールドのみに制限します。完全なv2クリーチャーオブジェクトははるかに大きく、トークン予算を無駄にします

HTTP 要求のプロパティのリファレンス​

• 認証: OAuth 2.0、API キー、基本認証の事前構築済みオプション。Open5e は何も必要としないため、ここでは「手動認証」に設定します。認証済み API の場合は、適切なオプションを選択し、資格情報を指定します。
• ヘッダー: すべての要求で送信されるキーと値のペア。一般的な用途: トークンベースの API に Authorization: Bearer <token> し、応答形式と API のバージョニング ヘッダーを制御する Accept: application/json 。
• 本文: JSON、フォーム データ、または生のコンテンツを送信するために、POST、PUT、PATCH 要求とともに使用されます。クエリ パラメーターを介して URL にパラメーターを保持する GET 要求には適用されません。
• クエリ パラメーター: URL に追加されるキーと値のペア。ワークフローの引数を参照するには、「 @ 」と入力して変数ピッカーを開き、引数を選択します。このフィールドには $input.<name> が格納され、チップとして表示されます。@ はピッカーのトリガー文字であり、入力できる参照構文ではありません。Studio Web での変数と式について詳しくは、「 アクティビティを設定する 」をご覧ください。
• 出力 ( searchResultsに名前を変更): ステータス コード、ヘッダー、本文を含む完全な HTTP 応答を受信します。既定の名前から変更しても、応答式は読みやすいままになります。

応答を追加します。​

1. ワークフロー キャンバスで、[HTTP 要求] の後の [ + ] を選択し、[ 応答] を選択します。

   [応答] アクティビティは、API ワークフローが呼び出し元に返す内容 (この場合は、ワークフローを呼び出したときにエージェントのツールが受け取る内容) を定義します。ここでの応答本文に入力した内容が、エージェントが推論を行うツールの出力になります。

2. 応答本文を次のように設定します。

   assignment

   {
     "monsterResults": $context.outputs.searchResults.content.results
   }
   {
     "monsterResults": $context.outputs.searchResults.content.results
   }
   

ワークフローをテストする​

1. ツールバーから [ デバッグ ] を選択します。
2. 入力パネルで [ searchName ] を [ dragon ] または [ goblin ] に設定し、ワークフローを実行します。
3. 続行する前に、応答にモンスター エントリを含む monsterResults 配列が含まれていることを確認します。

フィードにパブリッシュする​

1. ツールバーから [ パブリッシュ ] を選択します。
2. パブリッシュ ダイアログで [ 自分用 ] を選択して、個人用ワークスペース フィードにパブリッシュします。個人用ワークスペース フィードとは、Orchestrator ワークスペースに関連付けられたプライベート パッケージ リポジトリです。「自分の場合」をパブリッシュすると、このワークフローは自分だけに表示されるようになるので、開発やテストに適したスコープです。詳しくは、UiPath ドキュメントの「 個人用ワークスペース 」をご覧ください。
3. [ パブリッシュ ] を選択して確定します。

---