Oracle Cloud Infrastructure-Dokumentation

API-Endpunktaufruftool in Generative AI Agents erstellen

In Generative AI Agents muss jeder Agent über ein oder mehrere Tools verfügen. Sie können ein Agent-Tool während oder nach dem Erstellen des Agent erstellen. Für beide Optionen hat das Erstellen eines Tools die gleichen Schritte. In diesem Abschnitt werden die Schritte zum Erstellen eines API-Endpunktaufruf-Tools gezeigt.

Bevor Sie beginnen, lesen Sie die API Endpoint Calling Tool Guidelines for Generative AI Agents, und führen Sie alle erforderlichen Aufgaben aus. Beispiel: Sie müssen ein OCI Vault Secret erstellen und Policys hinzufügen, um auf Vault Secrets zuzugreifen.

API-Endpunktaufruf-Tool erstellen

  1. Wählen Sie Tool erstellen, Benutzerdefiniertes Tool aus.
  2. Geben Sie einen Namen und eine Beschreibung für dieses Tool ein.
  3. Wählen Sie unter Toolkonfiguration die Option API-Endpunktaufruf (Agent-Ausführung) aus.
  4. (Optional) Wählen Sie gegebenenfalls ein Beispiel aus.

    Wenn Sie ein Beispiel auswählen, wird das Beispiel in das Feld API-Schema für den Import von Inline kopiert. Fahren Sie mit Schritt 6 fort.

  5. Wählen Sie unter API-Schema importieren eine der folgenden Optionen aus, um das API-Schema für dieses Tool bereitzustellen. Ein API-Schema beschreibt die Vorgänge und Methoden des API-Endpunkts.
    • Inline: Bei einem kleinen Schema können Sie eine Zeichenfolge eingeben, die die Vorgänge und Methoden des API-Endpunkts enthält.
    • Aus Object Storage auswählen: Wählen Sie für ein großes Schema oder Schema mit häufigen Updates ein Compartment und einen Bucket aus. Wählen Sie dann die Datei aus, die das API-Schema enthält.
  6. Wählen Sie unter Authentifizierungstyp eine der folgenden Optionen aus, und schließen Sie die Toolkonfiguration nach Bedarf ab.
    • Keine: Zum Aufrufen öffentlicher oder privater API-Endpunkte, für die keine Authentifizierung erforderlich ist. Wenn diese Option ausgewählt ist, wird keiner Anrufanforderung ein Authentifizierungsheader hinzugefügt.
    • API-Schlüssel: Ein API-Schlüssel ist ein Token, das ein Client beim Ausführen von API-Aufrufen bereitstellt. Der API-Schlüssel muss in einem OCI Vault Secret gespeichert sein.
      • Schlüsselspeicherort: Geben Sie den Speicherort des API-Schlüssels in einer Aufrufanforderung an.
        • Wählen Sie Header aus, um den Schlüssel im Anforderungsheader zu senden.
        • Wählen Sie Abfrageparameter aus, um den Schlüssel als Abfrageparameter in der Anforderung zu übergeben.
      • Schlüsselname: Geben Sie den Namen eines Headers (z.B. Authorization) oder den Schlüsselnamen eines Abfrageparameters (z.B. appid) ein.
      • Vault Secret auswählen: Wählen Sie im entsprechenden Compartment das OCI Vault Secret aus, das den API-Schlüssel enthält.
    • Basis: HTTP-Basisauthentifizierung mit einem Benutzernamen und einem Kennwort. Die Zugangsdaten müssen im Format <your-username>:<your-password> angegeben und in einem OCI Vault Secret gespeichert werden.
      • Vault Secret auswählen: Wählen Sie im entsprechenden Compartment das OCI Vault Secret aus, das die Zugangsdaten im erforderlichen Format enthält.
    • Bearer: OAuth 2.0-Authentifizierung über ein Bearer-Token Das Token muss in einem OCI Vault Secret gespeichert werden.
      • Vault Secret auswählen: Wählen Sie im entsprechenden Compartment das OCI Vault Secret aus, das das Token enthält.
    • IDCS: OAuth 2.0-Authentifizierung mit der Client-ID und dem Client Secret, die von einer vertraulichen Oracle Identity Cloud Service-(IDCS-)Anwendung abgerufen werden. Das Client Secret muss in einem OCI Vault Secret gespeichert sein.
      • Identitätsdomain: Wählen Sie im entsprechenden Compartment die Identitätsdomain aus, in der dieses Tool erstellt werden soll.
      • Client-ID: Geben Sie die Client-ID der vertraulichen Anwendung ein.
      • Client Secret: Wählen Sie im entsprechenden Compartment das OCI Vault Secret aus, das das Client Secret für die vertrauliche Anwendung enthält.
      • Geltungsbereichs-URL: Geben Sie die Geltungsbereichs-URL ein, die eine bestimmte Gruppe von Ressourcen und Vorgängen definiert, auf die zugegriffen werden kann.
    • OCI-Resource Principal: Nur zum Aufrufen von OCI-Service-APIs wie Object Storage, Compute und Networking (VCN und Subnetz).
  7. Wählen Sie im entsprechenden Compartment das VCN und das Subnetz aus, das Sie verwenden möchten.
  8. Wählen Sie Tool erstellen aus.
Tipp

Führen Sie einen der folgenden Schritte durch:

  • Wenn Sie einen Agent erstellen, gehen Sie zurück zu Agent in Generative AI Agents erstellen, um ein anderes Tool oder einen Agent-Endpunkt zu erstellen.
  • Wenn Sie das Tool einem vorhandenen Agent hinzugefügt haben, wählen Sie nach der Aktivierung des Tools auf der Detailseite des Agent die Option Chat starten aus, um mit dem Agent zu chatten, der dieses Tool verwendet.
  • Wenn Sie den Agent ohne Agent-Endpunkt erstellt haben und bereit sind, den Agent zu verwenden, erstellen Sie einen Endpunkt für diesen Agent.
Hinweis

Um eine Antwort von einem menschlichen Prüfer überwachen und bearbeiten zu lassen, bevor sie an den Benutzer gesendet wird, wählen Sie das optionale Feature Mensch in Schleife aktivieren im Agent-Endpunkt aus.