Zum Inhalt springen

Verwenden Sie den Jitterbit API Manager AI-Assistenten

Einführung

Der APIM AI-Assistent hilft Ihnen, Assets im API Manager zu erstellen und zu verwalten, indem Sie mit ihm in natürlicher Sprache kommunizieren.

API Manager-Header mit geöffnetem AI-Bot

Hinweis

Um den APIM AI-Assistenten zu nutzen, muss Ihre Harmony-Lizenz die Option APIM AI-Assistent enthalten. Kontaktieren Sie Ihren Customer Success Manager (CSM), um diese Option zu Ihrer Lizenz hinzuzufügen.

Zugriff auf den AI-Assistenten

Greifen Sie von diesen Orten auf den Assistenten zu:

  • Im Header des Harmony-Portals auf jeder API Manager- oder Studio-Seite verwenden Sie das Jitterbit AI-Symbol. Wählen Sie im Panel im Dropdown-Menü APIM-Assistent aus.

  • Klicken Sie auf diesen API Manager-Seiten auf Neu > Mit AI erstellen:

  • Im Studio verwenden Sie das Menü für Betriebsaktionen, um Als API mit AI veröffentlichen auszuwählen.

  • Auf der Seite AI-Assistent der Management-Konsole greifen Sie auf die spezielle Vollseitenoberfläche für erweiterte Gespräche zu.

Unterstützte Interaktionen

Die folgenden Interaktionen werden unterstützt:

  • Benutzerdefinierte APIs: Erstellen, veröffentlichen, bearbeiten, testen, klonen und löschen.
  • Proxy-APIs: Erstellen, veröffentlichen, bearbeiten und testen.
  • Sicherheitsprofile: Erstellen, bearbeiten, zuweisen und löschen.
  • Vertrauenswürdige IP-Gruppen: Erstellen, bearbeiten, zuweisen und löschen.
  • API-Gruppen: Erstellen, bearbeiten, zuweisen und löschen.
  • API-Informationen: Detaillierte Erklärungen und Einblicke zu bestehenden APIs erhalten.

    Tipp

    Der Assistent bietet reichhaltigere und detailliertere Erklärungen, wenn Ihre API umfassende Beschreibungen und OpenAPI-Dokumentation enthält.

AI Assistant-Steuerungen

Das AI Assistant-Panel enthält diese Steuerungen:

  • Startseite: Kehren Sie zum aktuellen Chat aus dem Chatverlauf zurück.
  • Verlauf: Durchsuchen Sie Ihre vorherigen AI Assistant-Chats und wählen Sie einen aus, um ihn anzuzeigen.
  • Neuer Chat: Starten Sie einen neuen Chat.
  • Benutzer-Chat: Sehen Sie sich den Chatverlauf für einen bestimmten Benutzer an, indem Sie dessen Email-Adresse auswählen. Diese Option ist nur für Benutzer mit Admin Berechtigung verfügbar.

Erste Schritte

Um mit der Verwendung des APIM AI Assistant zu beginnen, verwenden Sie natürliche Sprache, um dem Assistenten mitzuteilen, was Sie möchten, dass er tut. Der Assistent führt Sie durch den Prozess der Erstellung oder Aktualisierung von Assets. Er wird um Bestätigung bitten, wenn dies erforderlich ist, Sie auffordern, wenn er weitere Informationen benötigt, und bestätigen, wenn er eine Aktion ausgeführt hat.

Wenn Sie Hilfe benötigen, um zu verstehen, wie Sie auf den Assistenten reagieren sollen, bitten Sie ihn, zu klären, was er meint, oder verwenden Sie die UI-Dokumentation als ergänzendes Referenzmaterial.

APIs

Sie können APIs erstellen, bearbeiten, veröffentlichen, testen, klonen und löschen.

Beispielbenutzereingaben

  • Erstellen Sie eine neue Proxy-API mit Standardwerten.
  • Fügen Sie meinem bestehenden API "Kunden" einen neuen API-Dienst hinzu.
  • Listen Sie die verfügbaren Entwurfs-APIs auf.
  • Löschen Sie einen der API-Dienste aus "Produkten".
  • Erzählen Sie mir von der API "Produkte".
  • Geben Sie mir eine Liste der verfügbaren Entwurfs-APIs zum Veröffentlichen.

Wenn Sie den Assistenten bitten, eine API zu löschen, wird er Sie warnen, wenn die API derzeit veröffentlicht ist, Sie bitten, zu bestätigen, dass Sie sie löschen möchten, und bestätigen, wenn sie erfolgreich gelöscht wurde.

Wenn Sie eine benutzerdefinierte API klonen, wird der Name der geklonten API mit Kopie von vorangestellt, der Dienststamm mit Kopie von vorangestellt und die Version mit einer erhöhten Zahl angehängt.

Wenn der Assistent eine API testet, die mit grundlegender Authentifizierung gesichert ist, wird er einen separaten UI-Dialog bereitstellen, um Ihre Anmeldeinformationen aus Sicherheitsgründen einzugeben. Ihre Anmeldeinformationen werden nicht mit dem großen Sprachmodell (LLM) geteilt.

Sicherheitsprofile

Sie können Sicherheitsprofile erstellen, bearbeiten, zuweisen und löschen, entweder beim Erstellen oder Bearbeiten einer API oder als separate Interaktion.

Beispielbenutzereingaben

  • Sichern Sie die "Kunden"-API mit einem neuen Profil für die grundlegende Authentifizierung.
  • Weisen Sie mein bestehendes Sicherheitsprofil "Mitarbeiterportal" der "Mitarbeiter"-API zu.
  • Erstellen Sie ein neues Sicherheitsprofil mit OAuth 2.0-Authentifizierung.
  • Zeigen Sie mir alle Sicherheitsprofile in der Produktionsumgebung an.

API-Gruppen

Sie können API-Gruppen erstellen, bearbeiten, zuweisen und löschen.

Beispielbenutzereingaben

  • Erstellen Sie eine API-Gruppe mit dem Namen "API_GRP_1" mit den APIs "Kunden" und "Produkte".
  • Fügen Sie die neue API "Bestellungen" zu "API_GRP_1" hinzu und listen Sie dann alle APIs in "API_GRP_1" auf.
  • Benennen Sie "API_GRP_1" in "API_GROUP_1" um und entfernen Sie die API "Kunden" daraus.
  • Zeigen Sie mir alle API-Gruppen in meiner Organisation an.

Vertrauenswürdige IP-Gruppen

Sie können vertrauenswürdige IP-Gruppen erstellen, bearbeiten, zuweisen und löschen.

Beispielbenutzereingaben

  • Erstellen Sie eine vertrauenswürdige IP-Gruppe mit dem Namen "Büro-Netzwerk" mit dem Bereich 192.0.2.10 bis 192.0.2.50.
  • Fügen Sie einen neuen IP-Bereich zur Gruppe "Büro-Netzwerk" hinzu.
  • Zeigen Sie mir alle vertrauenswürdigen IP-Gruppen an.
  • Weisen Sie die vertrauenswürdige IP-Gruppe "Büro-Netzwerk" meinem Sicherheitsprofil zu.

Empfehlungen

Sie sollten mit dem APIM AI Assistant interagieren, wie Sie es mit jedem großen Sprachmodell (LLM) AI-Produkt tun würden.

Die folgenden Vorschläge werden empfohlen:

  • Schreiben Sie auf Englisch mit den Formulierungen, die Ihnen natürlich erscheinen, als würden Sie mit einer Person mit Ihrem eigenen IT- und Geschäftswissen sprechen. Andere Sprachen können verwendet werden, wurden jedoch nicht validiert.

  • Um Ideen zu erhalten, welche Interaktionen Sie durchführen können, fragen Sie den Assistenten in natürlicher Sprache, was er tun kann, oder tippen Sie help.

  • Lesen Sie die Eingabeaufforderungen sorgfältig durch, bevor Sie Ihre Antwort eingeben. Wenn es etwas gibt, das Sie nicht verstehen, bitten Sie den Assistenten um Klarstellung.

  • Sobald der Assistent die Konfiguration der Assets abgeschlossen hat, überprüfen und bestätigen Sie, was er erstellt hat, indem Sie die Konfiguration im API-Manager durchsehen. Wenn einige Einstellungen nicht wie erwartet sind, können Sie den Assistenten bitten, sie zu bearbeiten, oder sie direkt bearbeiten.

Einschränkungen

Die folgenden Interaktionen werden derzeit nicht unterstützt:

  • Klonen und Löschen von Proxy-APIs.
  • Exportieren und Importieren von APIs.
  • Hochladen eines OpenAPI-Dokuments beim Erstellen einer Proxy-API.

Bekanntes Problem

Wenn der Assistent Sie auffordert, eine Umgebung auszuwählen, kann die Liste veraltet sein, wenn Sie Änderungen an den Umgebungen in derselben Browsersitzung vorgenommen haben. Als Workaround melden Sie sich vom Harmony-Portal ab und wieder an, damit der Assistent eine aktualisierte Liste der Umgebungen zurückgibt.