Erstellen Sie eine API mit dem Jitterbit API Manager AI Assistant

Einführung

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

Zugriff auf den AI Assistant

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 Assistant aus.
• Auf der API Manager APIs-Seite klicken Sie auf Neu > Mit AI erstellen.
• In Studio verwenden Sie das Menü für Betriebsaktionen, um Als API mit AI veröffentlichen auszuwählen.
• Auf der AI Assistant-Seite der Management-Konsole greifen Sie auf die dedizierte Vollbildoberflä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.

Steuerungen des AI Assistant

Das Panel des AI Assistant enthält diese Steuerungen:

• Startseite: Kehren Sie zur aktuellen Unterhaltung aus dem Chatverlauf zurück.
• Verlauf: Durchsuchen Sie Ihre vorherigen Chats mit dem KI-Assistenten 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 dem APIM KI-Assistenten zu beginnen, verwenden Sie natürliche Sprache, um dem Assistenten mitzuteilen, was Sie möchten, dass er tut. Zum Beispiel:

Der Assistent wird Sie durch den Prozess der Erstellung oder Aktualisierung einer API führen. Er wird um Bestätigung bitten, wenn dies erforderlich ist, Sie auffordern, wenn er mehr Informationen benötigt, und bestätigen, wenn er eine Aktion ausgeführt hat.

Sie können auch Sicherheitsprofile, API-Gruppen und vertrauenswürdige IP-Gruppen erstellen, bearbeiten, zuweisen und löschen, entweder während der Erstellung oder Bearbeitung einer API oder als separate Interaktion:

Sie können auch eine benutzerdefinierte API löschen oder klonen, um eine Kopie davon zu erstellen:

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, ob sie erfolgreich gelöscht wurde.

Ein geklonter API-Name wird mit Copy of vorangestellt, der Dienststamm mit Copyof und die Version mit einer erhöhten Zahl angehängt.

Sie können auch APIs veröffentlichen und testen:

Wenn der Assistent eine API testet, die mit grundlegender Authentifizierung gesichert ist, wird ein separates UI-Dialogfeld bereitgestellt, um Ihre Anmeldeinformationen aus Sicherheitsgründen einzugeben. (Ihre Anmeldeinformationen werden nicht mit dem LLM geteilt.)

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änzende Referenz.

Empfehlungen

Sie sollten mit dem APIM AI-Assistenten interagieren, wie Sie es mit einem beliebigen 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 durchsuchen. Wenn 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.