Verwenden Sie den Jitterbit API Manager AI Assistant

Einführung

Mit natürlicher Sprache hilft Ihnen der APIM AI Assistant, Assets in API Manager zu erstellen und zu verwalten sowie API-Analysedaten abzufragen, zu erklären und herunterzuladen.

Zugriff auf den APIM AI Assistant

Greifen Sie von diesen Orten auf den Assistant zu:

• Verwenden Sie in der Harmony-Portal-Kopfzeile auf einer beliebigen API Manager- oder Studio-Seite das Symbol Jitterbit AI. Verwenden Sie im Panel das Dropdown-Menü, um APIM AI Assistant auszuwählen.

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

  • APIs
  • Sicherheitsprofile
  • API-Gruppen
  • Vertrauenswürdige IP-Gruppen

• Klicken Sie auf der Seite Analytics auf AI fragen.

• Verwenden Sie in Studio das Menü für Vorgangsaktionen, um Als API mit AI veröffentlichen auszuwählen.

• Greifen Sie auf der Seite AI Assistant der Management Console auf die dedizierte Vollseiten-Schnittstelle für erweiterte Gespräche zu.

APIM AI Assistant-Steuerelemente

Das APIM AI Assistant-Panel enthält diese Steuerelemente:

• Startseite: Kehren Sie vom Chat-Verlauf zum aktuellen Chat zurück.
• Verlauf: Durchsuchen Sie Ihre vorherigen AI Assistant-Chats und wählen Sie einen aus, um ihn anzuzeigen.
• Chat kopieren: Kopieren Sie das gesamte Gespräch in die Zwischenablage.
• Neuer Chat: Starten Sie einen neuen Chat.
• Benutzer-Chat: Zeigen Sie den Chat-Verlauf für einen bestimmten Benutzer an, indem Sie seine E-Mail-Adresse auswählen. Diese Option ist nur für Benutzer mit der Berechtigung Admin Berechtigung verfügbar.
• Erweitern: Erweitert den Chat. Klicken Sie nach dem Erweitern auf das Symbol Minimieren, um zur vorherigen Ansicht zurückzukehren.
• Größe ändern: Ziehen Sie den linken Rand des Panels, um seine Breite anzupassen.

Unterstützte Interaktionen und Funktionen

Die folgenden Interaktionen und Funktionen 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: Erhalten Sie detaillierte Erklärungen und Einblicke zu vorhandenen APIs.

  Tipp

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

• Analytics: Fragen Sie API-Analysedaten ab, erklären Sie sie, fassen Sie sie zusammen und laden Sie sie herunter, einschließlich API-Aufrufe, Antwortzeit, Statuscodes, Fehler, Rate-Limit-Auslastung, Richtlinienverletzungen sowie Erkenntnisse zu Verbrauchern und IPs.

Erste Schritte

Um mit dem APIM AI Assistant zu beginnen, teilen Sie dem Assistant in natürlicher Sprache mit, was er tun soll. Der Assistant führt Sie durch den Prozess der Erstellung oder Aktualisierung von Assets. Er fordert Sie zur Bestätigung auf, wenn nötig, fordert Sie auf, wenn er weitere Informationen benötigt, und bestätigt, wenn er eine Aktion ausgeführt hat.

Wenn Sie Hilfe beim Verstehen der Antwort auf den Assistant benötigen, bitten Sie ihn, zu klären, was er meint, oder verwenden Sie die UI-Dokumentation als ergänzende Referenz.

APIs

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

Wenn du den Assistenten auffordest, einen API zu löschen, warnt er dich, falls der API gerade veröffentlicht ist, fordert dich auf, den Löschvorgang zu bestätigen, und teilt dir mit, wenn der API erfolgreich gelöscht wurde.

Beim Klonen eines benutzerdefinierten API wird dem Namen des geklonten API „Copy of" vorangestellt, der Service-Root wird mit „Copyof" vorangestellt und die Version wird um eine Nummer erhöht.

Wenn der Assistent einen API testet, der mit Basic Authentication gesichert ist, stellt er einen separaten UI-Dialog zur Verfügung, um deine Anmeldedaten aus Sicherheitsgründen einzugeben. Deine Anmeldedaten werden nicht mit dem Large Language Model (LLM) geteilt.

Sicherheitsprofile

Du kannst Sicherheitsprofile erstellen, bearbeiten, zuweisen und löschen – entweder beim Erstellen oder Bearbeiten eines API oder als separate Interaktion.

API-Gruppen

Du kannst API-Gruppen erstellen, bearbeiten, zuweisen und löschen.

Vertrauenswürdige IP-Gruppen

Du kannst vertrauenswürdige IP-Gruppen erstellen, bearbeiten, zuweisen und löschen.

Analytik

Du kannst den Assistenten auffordern, Daten von der Seite Analytik abzufragen, zu erklären, zusammenzufassen und herunterzuladen. Der Assistent verwendet automatisch die Umgebungs-, Zeitbereichs-, API-, Versions-, Methoden-, Statuscode- und Profilfilter, die derzeit auf der Seite Analytik angewendet werden, sodass du diesen Kontext in deiner Eingabe nicht wiederholen musst.

Wenn eine Anfrage das Filtern der Daten erfordert, z. B. „zeige nur 4xx-Fehler" oder „filtere nach diesem API", wendet der Assistent den entsprechenden Filter auf der Seite Analytik an.

Du kannst auch Analysen-Fragen von anderen API Manager-Seiten stellen. Der Assistent navigiert dich zur Seite Analytik, um sie zu beantworten.

Du kannst den Assistenten auch auffordern, ein einzelnes Diagramm zu erweitern oder zu reduzieren. Der Assistent tut dies nur, wenn du ihn dazu auffordert.

Du kannst den Assistenten auch auffordern, Daten aus der Tabelle API-Zustandsüberwachung oder aus den Diagrammen in den Abschnitten Aufrufsmetriken und API-Consumer als CSV-Datei herunterzuladen, was dem Verhalten Als CSV herunterladen für die Tabelle und dem Verhalten Als CSV herunterladen für einzelne Diagramme entspricht. Der Assistent wendet die Filter an, die derzeit auf der Seite Analytik aktiv sind, auf den Download an.

Empfehlungen

Sie sollten mit dem APIM AI Assistant wie mit jedem großen Sprachmodell (LLM) AI-Produkt interagieren. Beachten Sie diese Vorschläge:

• Schreiben Sie auf Englisch mit der Formulierung, die Ihnen natürlich in den Sinn kommt, als würden Sie mit einer Person auf Ihrem eigenen IT- und Business-Wissensniveau sprechen. Andere Sprachen können verwendet werden, wurden aber nicht validiert.

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

• Lesen Sie die Antworten des Assistenten sorgfältig durch, bevor Sie Ihre Antwort eingeben. Wenn Sie etwas nicht verstehen, bitten Sie den Assistenten um Klarstellung.

• Nachdem der Assistent eine Aktion ausgeführt hat, können Sie überprüfen und bestätigen, was er getan hat, indem Sie die Konfiguration in der Benutzeroberfläche durchsuchen. Wenn einige Einstellungen nicht wie erwartet sind, können Sie den Assistenten bitten, diese zu bearbeiten, oder bearbeiten Sie sie direkt.

Einschränkungen

Die folgenden Interaktionen werden noch nicht unterstützt:

• Proxy-APIs klonen und löschen.
• APIs exportieren und importieren.
• Ein OpenAPI-Dokument beim Erstellen einer Proxy-API hochladen.
• Prädiktive Analytik, automatische Behebung oder Benachrichtigungserstellung aus Analysedaten.
• Analysberichte oder Exporte über CSV-Download hinaus.