最初の API ワークフローを構築する

次のチュートリアルでは、Petstore パブリック API を使用した簡単な例を通じて、API ワークフロー インターフェイスの背後にある重要な概念を実際に体験できます。

この例では、言語モデル (LLM) に「ペットの情報」を要求し、そのデータを使用して Swagger Petstore にペットを追加します。スワガーペットストア(https://petstore.swagger.io)認証の有無にかかわらず、アクセス可能で使いやすい API エンドポイントを提供します。

手順 1: LLM を呼び出す

1. API ワークフロー デザイナー キャンバスで、[ 追加 ] (プラス + アイコン) を選択します。
2. [コンテンツ生成] > [コネクタ > UiPath GenAI アクティビティ] を選択します。
3. [プロパティ] パネルで既存のコネクションを設定するか、既存のコネクションを選択します。
4. 次のプロパティを設定します。
   • モデル—GPT-4o-mini-2024-07-18

   • プロンプト

     「威勢のいいペットストアのために、インベントリに追加できる新しいファンタジークリーチャーの詳細を作成します。有効な json でのみ応答します。これらの 5 つの配列を返します。

5. ここまでのワークフローをデバッグします。
6. [出力] パネルで結果を確認します。アクティビティ呼び出しの生の入力と出力が表示されます。応答は次のようになります。

   {
     "cacheReadInputTokens": 0,
     "created": 1745444601,
     "usage": {
       "total_tokens": 741,
       "completion_tokens": 686,
       "prompt_tokens": 55,
       "cache_read_input_tokens": 0
     },
     "contextGroundingCitationsString": "[]",
     "totalTokens": 741,
     "promptTokens": 55,
     "model": "gpt-4o-mini-2024-07-18",
     "id": "chatcmpl-BPcADRRpy7ZDZpBOxp6XJYk0HOpaa",
     "text": "```json\n[\n    {\n        ....  \"A stealthy creature that blends into the shadows, highly elusive.\"\n    }\n]\n```",
     "choices": [
       {
         "index": 0,
         "finish_reason": "stop",
         "message": {
           "content": "```json\n[\n  ...ws, highly elusive.\"\n    }\n]\n```",
           "role": "assistant"
         }
       }
     ],
     "completionTokens": 686,
     "object": "chat.completion"
   }

手順 2: スクリプトを使用して応答の書式を適切に設定する

必要な情報は content.text プロパティ内にあり、このプロパティが正しく書式設定されていません。

1. 現在の API ワークフローに [ スクリプト ] アクティビティを追加します。
2. [式エディター] を開き、次のように書き込みます。

   const cleanedJsonStr = $context.outputs.v2_sub_generateChatCompletion_1.content.text
     .replace(/^```json\n/, '')
     .replace(/\n```$/, '');
   
   // Step 2: Parse into JSON
   let parsedObj;
   parsedObj = JSON.parse(cleanedJsonStr);
   return { aipet: parsedObj };

   この JavaScript コードは、 content.text オブジェクトを解析し、クリーンな形式で返します。
3. ワークフローを再度デバッグします。適切な形式の応答を確認します。

手順 3: 応答配列を反復処理する

LLM は、手順 1 のプロンプトに示されているように、複数のペットの例を配列として返しました。

1. 現在の API ワークフローに、[ループ > ForEach ] アクティビティを追加します。

2. [繰り返し (コレクションの各要素)] アクティビティは次のように設定します。

   • で—

     $context.outputs.Javascript_1.aipet

   • 項目名 - currentItem
   • 結果の蓄積 - オン

   このコマンドは、応答配列のすべての項目を反復処理します。

手順 4: 返された応答を Petstore に追加する

1. [繰り返し (コレクションの各要素)] アクティビティの本体内に [HTTP] アクティビティを追加し、次のように設定します。
   • メソッド - POST
   • 要求 URL —https://petstore.swagger.io/v2/pet

   • 要求本文 - 式エディターを開き、[Autopilot] フィールドに「この foreach 内で、各オブジェクトを変換して、Swagger Petstore Pet Creation に投稿できるようにします。前の手順で各プロパティの値を見つけます。

     Autopilot の応答は次のようになります (このスニペットをコピーすることもできます)。

     {
       id: $currentItem.id,
       name: $currentItem.name,
       category: $currentItem.category,
       photoUrls: $currentItem.photoUrls,
       tags: $currentItem.tags,
       status: $currentItem.status,
       age: $currentItem.age,
       properties: $currentItem.properties
     }

2. ワークフローをデバッグします。この時点で、API ワークフローは [成功] ステータスを返します。これは、ペットデータがペットストアに正しく転記されたことを意味します。

手順 5: ワークフローの応答を返す

この手順では、ワークフローの最終結果を、クリーンで簡略化された形式で外部コンシューマーに公開します。

1. 現在の API ワークフローに [応答 ] アクティビティを追加し、次のように設定します。
   • タイプ - 成功
   • [詳細] - [式エディター] を開き、以下を書き込みます。

     $context.outputs.For_Each_1.results.map(result => ({
       id: result.content.id,
       name: result.content.name,
       description: result.content.description
     }))

     このスニペットは、記載された詳細を含むカスタム JSON を返します。
2. ワークフローをデバッグします。3 つの詳細を含む最終的な応答に注目してください。

手順 6: 入力スキーマと出力スキーマを定義する

この手順により、外部コンシューマーがワークフロー オブジェクトを使用できるようになります。

1. 現在の API ワークフローで、[ データ マネージャー ] パネルを開きます。
2. [入力] タブの場合
   • 新しいプロパティを追加し、「Genre」という名前を付けます。
   • 型を String 型に設定します。
   • 必須としてマークします。
3. [ 出力 ] タブの場合
   • 3 つのプロパティを追加し、「id」、「name」、「type」という名前を付けます。これらは、ワークフローによって返されるプロパティです。
   • [型] を [文字列] に設定します。
4. ワークフローで [ コンテンツ生成 ] アクティビティを選択します。

   1. [プロンプト] フィールドを次のように更新します。

      "Swagger Petstoreの場合、インベントリに追加できる新しい「+$workflow.input.Genre+」クリーチャーの詳細を作成します。ペットの情報を保持する json オブジェクトでのみ応答します。

      この新しいプロンプトでは、[入力スキーマ] で定義された $workflow.input.Genre プロパティが使用されます。

5. デバッグ構成を定義し、 Genre プロパティの値:

   { Genre: "Fantasy" }

手順 7: パブリッシュと実行

ワークフローの構築が正常に完了しました。

1. ワークフローを Orchestrator の [個人用ワークスペース] フォルダーにパブリッシュします。
2. 対応するプロセスが作成されたサブフォルダーに移動し、[ ジョブを開始] を選択します。

Orchestrator はワークフローの入力スキーマを読み取るので、ジャンルを入力する必要があります。値を指定すると、ジョブが開始されます。