Beispiel A: Erstellen Sie einen Connector aus einer leeren Canvas mit Authentifizierung mit persönlichem Zugriffstoken

Im folgenden Beispiel erstellen wir einen Connector für OpenAI DALL-E aus einer leeren Canvas mithilfe der Authentifizierung des persönlichen Zugriffstokens.

Erstellen Sie den neuen Connector

Dieses Beispiel zeigt, wie Sie das OpenAI-Modell DALL-E verwenden, um ein Bild basierend auf einer Textaufforderung zu generieren.

1. Navigieren Sie zu Integration Service.

2. Wählen Sie auf der Seite Connector-Katalog die Option Connector erstellen oder Connector-Generator aus.

3. Wählen Sie als Nächstes Neuen Connector erstellen.

4. Wählen Sie Mit leerer Stelle beginnen aus.

5. Fügen Sie einen Namen für Ihren Connector und optional eine Beschreibung und ein Symbol hinzu.

6. Wählen Sie Erstellen.

   

Konfigurieren Sie die API-Ressource

Wie es funktioniert

Sehen wir uns zuerst an, wie das Generieren eines Bildes über die API funktioniert.

Mit DALL-E geben Sie einen Prompt an, das Modell schreibt ihn aus Sicherheitsgründen automatisch neu und fügt weitere Details hinzu. Detaillierte Aufforderungen führen im Allgemeinen zu einer höheren Ausgabequalität. Dann gibt das Modell das generierte Bild entweder über einen Link ("responseformat": "URL") oder einen Base64-String ("responseformat": "b64_json") aus. Die URL ist der Standardwert gemäß der API-Spezifikation. Weitere Informationen zu den API-Parametern finden Sie unter API-Referenz – OpenAI-API.

Hier ist eine Beispiel-cURL zum Generieren eines Bildes mit dieser API:

cURL https://api.openai.com/v1/images/generations \   -H "Content-Type: application/json" \   -H "Authorization: Bearer $OPENAIAPIKEY" \   -d '{       "model": "dall-e-3",      "prompt": "A robot automating human task in computer",      "n": 1,      "size": "1024x1024"    }'

Richten Sie den Authentifizierungsmechanismus und die Ressourcen ein

Beim Erstellen der ersten API-Ressource für Ihren Connector müssen Sie drei wichtige Dinge beachten:

• Basis-URL
• Authentifizierungstyp
• API-Vorgang und -Ressource (manchmal als Routen bezeichnet)

Bei der Analyse der vorherigen cURL können Sie die folgenden Komponenten beobachten:

• Basis-URL: https://api.openai.com/images
• Authentifizierungstyp: Authorization: Bearer $OPENAIAPIKEY
• API-Vorgang und -Ressource: post /generations

Die Basis-URL gibt den Speicherort oder den Endpunkt der API-Ressource an, für die die Aufrufe erstellt werden sollen.

Der Authentifizierungstyp teilt dem Connector mit, wie der Benutzer authentifiziert wird, bevor er die API-Ressource verwenden darf. In diesem Beispiel verwenden wir das persönliche Zugriffstoken als Bearer-Token im Autorisierungsheader mit dem OpenAI-API-Schlüssel.

Die API-Routen – der Vorgang und die Ressource – bieten den Pfad zu einer bestimmten Ressource, die in der API verfügbar ist, z. B. /generations. Die Ressource wird an die Basis-URL angehängt, über die diese Ressource abgerufen/aufgelistet (GET), hinzugefügt/eingefügt (POST ), aktualisiert/upsert (PATCH/PUT) oder gelöscht () werden kann.DELETE).

Sie können basierend auf den Aktivitäten, die Sie für Ihren Workflow benötigen, beliebig viele API-Ressourcen und Vorgänge hinzufügen. Sie können beispielsweise Bilder generieren (POST /generations), alle generierten Bilder mit GET /generations auflisten (wenn der GET-Vorgang für die Ressource verfügbar ist) oder ein vorhandenes Bild bearbeiten (POST /edits).

Hinweis:

Connector-Generator unterstützt derzeit application/json als Inhaltstyp der Nutzlast und nicht als Formulardaten. Die Bildbearbeitungsfunktion des DALL-E-Modells ist derzeit möglicherweise nicht mit Connector Builder möglich.

Testen Sie die API-Ressourcenausgabe

Bevor Sie den Connector in Ihrem Workflow veröffentlichen und verwenden, testen Sie ihn zuerst.

1. Stellen Sie sicher, dass sich Ihr Connector im Status „Verbunden“ befindet. Wählen Sie Verbindung hinzufügen in der oberen rechten Ecke des Fensters und richten Sie eine Verbindung über den ausgewählten Authentifizierungsmechanismus ein.

   

2. Navigieren Sie zu Ihrer ersten API-Ressource und wählen Sie Anforderung senden aus.

3. Geben Sie den Text oder die Nutzlast für die API an, wie im folgenden cURL-Skript angegeben:

   {     "model": "dall-e-3",     "prompt": "A robot automating human task in computer",     "n": 1,     "size": "1024x1024"   }{     "model": "dall-e-3",     "prompt": "A robot automating human task in computer",     "n": 1,     "size": "1024x1024"   }

   

   

   

Konfigurieren Sie die Aktivitäten

Da Sie jetzt Ihren Connector testen können, können Sie über Aktivitätsdesigner das Design der Workflow-Komponente für diese spezifische Aktivität konfigurieren.

Aktivitätsdesigner hilft Ihnen beim Kuratieren von Eingabe- und Ausgabefeldern, die Sie Benutzern für diese Aktivität zur Verfügung stellen möchten. Dies gibt das „Erscheinungsbild“ an, wenn der API-Connector in UiPath Studio oder Studio Web verwendet wird. Weitere Informationen dazu finden Sie unter Aktivitätsdesigner.

Sie können den Anzeigenamen von Feldern ändern, Eingabefelder als erforderlich markieren oder nicht, ob es sich um einen primären oder sekundären Parameter handelt usw. Die Eingabefelder werden automatisch aus den Anforderungsfeldern oder dem Text generiert, sobald Sie eine Aktion zum Senden einer Anforderung ausführen.

Was die Antwort- oder Ausgabefelder betrifft, können Sie den Antwortstammschlüssel aktualisieren, sodass Sie bestimmte Ausgabeattribute aus der API-Antwort kuratieren können, z. B. revised_prompt oder URL, wie in der folgenden Abbildung erfasst.

Veröffentlichen Sie den Connector

Als Nächstes veröffentlichen Sie Ihren Connector in dem Mandanten Ihrer Wahl. Weitere Informationen finden Sie unter Veröffentlichen Ihres Connectors. Dann können Sie sie in Ihren Studio Desktop- oder Studio Web-Workflows verwenden.

Studio Web

1. Erstellen Sie in Studio Web ein neues Projekt. Suchen Sie im Aktivitätssuchbereich nach Ihrer benutzerdefinierten Aktivität und fügen Sie sie Ihrem Workflow hinzu.

   

2. Erstellen Sie in der benutzerdefinierten Aktivität die Verbindung und beginnen Sie dann mit der Konfiguration der Parameter.

3. Testen Sie Ihren Workflow.

StudioDesktop

Hinweis:

Sie benötigen Studio Desktop 2023.10 oder neuer.

1. Stellen Sie sicher, dass Studio Desktop mit demselben Mandanten verbunden ist, bei dem der Connector veröffentlicht wurde.

2. Stellen Sie im Aktivitätenbereich sicher, dass der Filter Verfügbar aktiviert ist.

3. Suchen Sie im Bereich Aktivitäten im Abschnitt Verfügbar nach Ihrem Connector-Namen. Ziehen Sie eine beliebige Aktivität in Ihren Workflow und legen Sie sie ab. Dadurch wird das einheitliche UiPath.IntegrationService.Activities -Paket installiert, das alle Integration Service-basierten Aktivitäten enthält, einschließlich Ihrer benutzerdefinierten.

4. Alternativ können Sie den Bereich Pakete verwalten verwenden, um nach dem Paket UiPath.IntegrationService.Activities zu suchen und zu installieren.