Erstellen Ihres ersten API-Workflows

Das folgende Tutorial bietet praktische Erfahrungen mit den wichtigsten Konzepten hinter der API-Workflow-Schnittstelle anhand eines einfachen Beispiels mit der öffentlichen Petstore-API.

In diesem Beispiel fordern Sie „Tierinformationen“ von einem Sprachmodell (LLM) an und verwenden diese Daten, um Tiere zum Swagger Petstore hinzuzufügen. Der Swagger- Zoohandlung (https://petstore.swagger.io) bietet zugängliche und benutzerfreundliche API-Endpunkte, die mit oder ohne Authentifizierung verfügbar sind.

Schritt 1: Aufrufen des LLM

1. Wählen Sie auf der Arbeitsfläche Ihres API-Workflowdesigners die Option Hinzufügen aus (das Pluszeichen +-Symbol).
2. Wählen Sie Connector > UiPath GenAI-Aktivitäten > Inhaltsgenerierung aus.
3. Richten Sie eine vorhandene Verbindung im Eigenschaftenbereich ein oder wählen Sie eine vorhandene aus.
4. Konfigurieren Sie diese Eigenschaften:
   • Modell – gpt-4o-mini-2024-07-18

   • Prompt

     „Erstellen Sie für den Swagger- Zoohandlung die Details einer neuen Importware, die ihrem Bestand hinzugefügt werden kann. Antworten Sie nur mit gültiger JSON. Gibt ein Array mit 5 davon zurück.“

5. Debuggen Sie Ihren Workflow bis zu diesem Zeitpunkt.
6. Sehen Sie sich die Ergebnisse im Bereich Ausgabe an. Sie sollten die unformatierte Eingabe und Ausgabe des Aktivitätsaufrufs sehen. Die Antwort sollte folgendermaßen aussehen:

   {
     "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"
   }

Schritt 2: Verwenden eines Skripts zum richtigen Formatieren der Antwort

Die von Ihnen benötigten Informationen befinden sich in der Eigenschaft content.text , die nicht korrekt formatiert ist.

1. Fügen Sie zu Ihrem aktuellen API-Workflow die Aktivität Script hinzu.
2. Öffnen Sie den Ausdrucks-Editor und schreiben Sie Folgendes:

   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 };

   Dieser JavaScript-Code analysiert das content.text -Objekt und gibt es in einem sauberen Format zurück.
3. Debuggen Sie Ihren Workflow erneut. Beachten Sie die richtig formatierte Antwort.

Schritt 3: Durchlaufen des Antwort-Arrays

Das LLM gab mehrere String-Beispiele als Array zurück, wie in der Eingabeaufforderung von Schritt 1 angegeben.

1. Fügen Sie zu Ihrem aktuellen API-Workflow die Aktivität Loop > ForEach hinzu.

2. Konfigurieren Sie die „For Each“-Aktivität wie folgt:

   • In–

     $context.outputs.Javascript_1.aipet

   • Elementname– CurrentItem
   • Ergebnisse kumulieren– Ein

   Dieser Befehl durchläuft jedes Element des Antwort-Arrays.

Schritt 4: Hinzufügen der zurückgegebenen Antwort zu Petstore

1. Fügen Sie im Aktivitätstext For Each die HTTP- Aktivität hinzu und konfigurieren Sie sie wie folgt:
   • Methode– POST
   • Anforderungs-URL–https://petstore.swagger.io/v2/pet

   • Anforderungstext– Öffnen Sie den Ausdrucks-Editor und geben Sie in das Autopilot-Feld Folgendes ein: „Transformieren Sie in dieser ForEach-Aktivität jedes Objekt so, dass es in der Swagger Petstore Petstore-Kreation gepostet werden kann.“ Suchen Sie die Werte für jede Eigenschaft im vorherigen Schritt.“

     Die Autopilot-Antwort sollte wie folgt aussehen (Sie können dieses Snippet auch kopieren:

     {
       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. Debuggen Sie Ihren Workflow. An diesem Punkt sollte Ihr API-Workflow den Status „Erfolgreich“ zurückgeben. Das bedeutet, dass die Roboterdaten korrekt an den Zoohandlung gepostet wurden.

Schritt 5: Zurückgeben einer Workflow-Antwort

In diesem Schritt werden die endgültigen Ergebnisse des Workflows in einem sauberen, vereinfachten Format für externe Verbraucher verfügbar gemacht.

1. Fügen Sie zu Ihrem aktuellen API-Workflow die Aktivität Response hinzu und konfigurieren Sie sie wie folgt:
   • Typ– Erfolg
   • Details– Öffnen Sie den Ausdruckseditor und schreiben Sie Folgendes:

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

     Dieses Snippet gibt ein benutzerdefiniertes JSON-Objekt mit den genannten Details zurück.
2. Debuggen Sie Ihren Workflow. Beachten Sie die letzte Antwort mit den drei Details.

Schritt 6: Definieren von Eingabe- und Ausgabeschemas

In diesem Schritt werden die Workflow-Objekte für externe Verbraucher verfügbar.

1. Öffnen Sie für Ihren aktuellen API-Workflow den Bereich Data Manager .
2. Für die Registerkarte Eingabe :
   • Fügen Sie eine neue Eigenschaft hinzu und nennen Sie sie „Genre“.
   • Legen Sie den Typ auf String fest.
   • Markieren Sie sie als erforderlich.
3. Für die Registerkarte Ausgabe :
   • Fügen Sie drei Eigenschaften hinzu und nennen Sie sie „id“, „name“ und „type“. Dies sind die Eigenschaften, die vom Workflow zurückgegeben werden.
   • Legen Sie ihren Typ auf String fest.
4. Wählen Sie die Aktivität Content Generation in Ihrem Workflow aus.

   1. Aktualisieren Sie das Feld Aufforderung auf:

      "Erstellen Sie für den Swagger- Zoohandlung die Details einer neuen " + $workflow.input.Genre + " -Kre mehr, die ihrem Bestand hinzugefügt werden kann. Reagieren Sie nur mit einem JSON-Objekt, das die Roboterinformationen enthält.“

      Diese neue Eingabeaufforderung verwendet die im Eingabeschema definierte Eigenschaft $workflow.input.Genre .

5. Definieren Sie eine Debug-Konfiguration und geben Sie einen Wert für die Eigenschaft Agent an:

   { Genre: "Fantasy" }

Schritt 7: Veröffentlichen und Ausführen

Sie haben das Ende einer erfolgreichen Workflow-Erstellung erreicht.

1. Veröffentlichen Sie den Workflow in Ihrem Ordner „Persönlicher Arbeitsbereich“ im Orchestrator.
2. Navigieren Sie zum Unterordner, in dem der entsprechende Prozess erstellt wurde, und wählen Sie Auftrag starten aus.

Der Orchestrator liest das Workflow-Eingabeschema und erfordert die Eingabe eines Genre. Sobald Sie einen Wert angeben, wird der Auftrag gestartet.