Zum Inhalt springen

Verwende den Jitterbit API Manager AI-Assistenten

Einführung

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

API Manager-Header mit offenem AI-Assistenten

Hinweis

Um den APIM AI-Assistenten zu nutzen, muss deine Harmony-Lizenz die Option APIM AI-Assistenten enthalten. Kontaktiere deinen Customer Success Manager (CSM), um diese Option zu deiner Lizenz hinzuzufügen.

Greifen Sie auf den APIM AI-Assistenten zu

Rufe den Assistenten von diesen Stellen auf:

  • In der Harmony-Portal-Kopfzeile auf jeder API Manager oder Studio-Seite nutze das Jitterbit AI-Symbol. Wähle im Panel über das Dropdown-Menü APIM AI-Assistenten aus.

  • Von diesen API Manager-Seiten aus klicke auf Neu > Mit AI erstellen:

  • Klicke auf der Seite Analytik auf AI fragen.

  • Nutze in Studio das Menü für Operationsaktionen, um Mit AI als API veröffentlichen auszuwählen.

  • Auf der Seite AI-Assistenten der Management Console greifen Sie auf die dedizierte Vollseiten-Schnittstelle für erweiterte Unterhaltungen zu.

APIM AI-Assistenten-Steuerelemente

Das APIM AI-Assistenten-Panel umfasst diese Steuerelemente:

  • Startseite: Kehre vom Chat-Verlauf zum aktuellen Chat zurück.
  • Verlauf: Durchsuche deine vorherigen AI-Assistenten-Chats und wähle einen aus, um ihn anzuzeigen. Für Nutzer mit Admin-Berechtigung zeigt jeder Chat in der Liste auch seine Token-Nutzung (Prompt-, Cached- und Response-Token-Anzahl) an, sobald der Chat mindestens einen Nachrichtenaustausch hat. Nutzer ohne Admin-Berechtigung sehen nur Chat-Titel.
  • Chat kopieren: Kopiere die vollständige Unterhaltung in die Zwischenablage.
  • Neuer Chat: Starte einen neuen Chat.
  • Erweitern: Erweitert den Chat. Klicke nach dem Erweitern auf das Minimieren-Symbol, um zur vorherigen Ansicht zurückzukehren.
  • Weitere Aktionen: Öffnet ein Menü mit der folgenden Option:
    • Benutzerchat: Zeige den Chat-Verlauf eines bestimmten Benutzers an, indem du seine E-Mail-Adresse auswählst. Die Chat-Liste enthält die Token-Nutzung jedes Chats, wie in Verlauf beschrieben. Diese Option ist nur für Nutzer mit Admin-Berechtigung verfügbar.
  • Größe ändern: Ziehe die linke Kante 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: Erhalte detaillierte Erklärungen und Einblicke zu bestehenden APIs.

    Tipp

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

  • Analytik: Frage API-Analysedaten ab, erkläre, fasse zusammen und lade sie herunter, einschließlich API-Aufrufe, Antwortzeit, Statuscodes, Fehler, Rate-Limit-Nutzung, Richtlinienverletzungen sowie Erkenntnisse zu Verbrauchern und IPs.

Erste Schritte

Um mit dem APIM AI-Assistenten zu beginnen, sage dem Assistenten in natürlicher Sprache, was er tun soll. Der Assistent leitet dich durch den Prozess der Erstellung oder Aktualisierung von Assets. Er fragt um Bestätigung, wenn nötig, fordert dich auf, wenn er weitere Informationen benötigt, und bestätigt, wenn er eine Aktion ausgeführt hat.

Wenn Sie Hilfe beim Verständnis der Antwort auf den Assistenten benötigen, bitten Sie ihn um eine Klärung oder nutzen Sie die Benutzeroberflächendokumentation als zusätzliche Referenz.

APIs

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

Beispiele für Benutzereingaben

  • Erstellen Sie eine neue Proxy-API mit Standardwerten.
  • Fügen Sie meiner bestehenden API „Customers" einen neuen API-Service hinzu.
  • Listen Sie die Entwurfs-APIs auf, die mir zur Verfügung stehen.
  • Löschen Sie einen der API-Services aus „Products".
  • Erzählen Sie mir von der API „Products".
  • Geben Sie mir eine Liste der Entwurfs-APIs, die zur Veröffentlichung bereit sind.

Wenn Sie den Assistenten auffordern, eine API zu löschen, warnt er Sie, wenn die API derzeit veröffentlicht ist, fordert Sie auf, zu bestätigen, dass Sie sie löschen möchten, und bestätigt, wenn sie erfolgreich gelöscht wurde.

Beim Klonen einer benutzerdefinierten API wird dem Namen der geklonten API Copy of vorangestellt, dem Service-Root Copyof vorangestellt, und die Version wird mit einer erhöhten Nummer ergänzt.

Wenn der Assistent eine mit Standardauthentifizierung gesicherte API testet, stellt er ein separates UI-Dialogfeld zur Eingabe Ihrer Anmeldedaten bereit. Ihre Anmeldedaten 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.

Beispiele für Benutzereingaben

  • Sichern Sie die API „Customers" mit einem neuen Profil für die Standardauthentifizierung.
  • Weisen Sie mein vorhandenes Sicherheitsprofil „Employee Portal" der API „Employees" zu.
  • Erstellen Sie ein neues Sicherheitsprofil mit OAuth 2.0-Authentifizierung.
  • Zeigen Sie mir alle Sicherheitsprofile in der Produktionsumgebung.

API-Gruppen

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

Beispiele für Benutzereingaben

  • Erstellen Sie eine API-Gruppe namens „API_GRP_1" mit den APIs „Customers" und „Products".
  • Fügen Sie die neue API „Orders" 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 „Customers" daraus.
  • Zeigen Sie mir alle API-Gruppen in meiner Organisation.

Vertrauenswürdige IP-Gruppen

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

Beispiele für Benutzereingaben

  • Erstellen Sie eine vertrauenswürdige IP-Gruppe namens „Office Network" mit dem Bereich 192.0.2.10 bis 192.0.2.50
  • Fügen Sie einen neuen IP-Bereich zur Gruppe „Office Network" hinzu.
  • Zeigen Sie mir alle vertrauenswürdigen IP-Gruppen.
  • Weisen Sie die vertrauenswürdige IP-Gruppe „Office Network" meinem Sicherheitsprofil zu.

Analytik

Sie können den Assistenten bitten, Daten von der Seite Analytik abzufragen, zu erläutern, zusammenzufassen und herunterzuladen. Der Assistent verwendet automatisch die Umgebung, den Zeitbereich, die API, Version, Methode, den Statuscode und die Profilfilter, die derzeit auf der Seite Analytik angewendet werden, sodass Sie diesen Kontext in Ihrer Eingabe nicht erneut angeben müssen.

Beispiele für Benutzereingaben

  • Welche APIs haben in den letzten 7 Tagen die meisten API-Aufrufe?
  • Zeigen Sie mir den Trend der API-Aufrufe für diese API.
  • Welche APIs haben die meisten 5xx-Fehler (Serverfehler)?
  • Wie viele Aufrufe pro Minute (CPM) gibt es gerade?
  • Nähern wir uns den Ratenlimits?
  • Welche Verbraucher oder IP-Adressen generieren die meisten API-Aufrufe?
  • Fassen Sie die API-Leistung diese Woche zusammen und heben Sie wichtige Probleme hervor.
  • Laden Sie Aufrufmetriken für die letzten 7 Tage herunter.
  • Erweitern Sie das Diagramm „Gesamtaufrufe".
  • Reduzieren Sie dieses Diagramm „Hits".

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

Sie können auch Analysen-Fragen von anderen API Manager-Seiten stellen. Der Assistent führt Sie zur Seite Analytik, um diese zu beantworten.

Sie können den Assistenten auch bitten, ein einzelnes Diagramm zu erweitern oder zu reduzieren. Der Assistent tut dies nur, wenn Sie ihn dazu auffordern.

Sie können den Assistenten auch bitten, Daten aus der Tabelle API-Integritätsüberwachung oder aus den Diagrammen in den Abschnitten Anrufmetriken und API-Verbraucher als CSV-Datei herunterzuladen, die 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.

Hinweis

Der Assistent gibt nur die Analysedaten zurück und lädt diese herunter, auf die Sie Zugriff haben.

Empfehlungen

Interagieren Sie mit dem APIM AI Assistant so, wie Sie mit jedem großen Sprachmodell (LLM) AI-Produkt interagieren würden. Befolgen Sie diese Vorschläge:

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

  • Um Ideen für mögliche Interaktionen zu erhalten, 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 antworten. Falls Sie etwas nicht verstehen, bitten Sie den Assistenten, es zu erklären.

  • 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 UI durchsuchen. Falls Einstellungen nicht wie erwartet aussehen, 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 Remediation oder Alerterstellung aus Analysedaten.
  • Analysereporte oder Exporte über CSV-Download hinaus.

Bekanntes Problem

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