Verwendung des API-Assistenten zur Verbesserung Ihrer API-Spezifikationen

Sie können den API-Assistenten verwenden, um Ihre OpenAPI 3.0 Spezifikationen zu analysieren und KI-Empfehlungen für Validierungskorrekturen und Dokumentationsverbesserungen zu erstellen. Die Verbesserung Ihrer API-Spezifikationen beschleunigt deren Annahme durch die Verbraucher.

Produktinfo

Der API-Assistent in IBM® API Connect verwendet IBM watsonx Granite LLM Modelle, damit Sie Ihre APIs schneller erstellen können. Nutzen Sie den API-Assistenten, um schnell KI-Korrekturen für Ihre API-Definitionen zu erstellen und hilfreiche Beschreibungen und Beispiele für Ihre API-Dokumente vorzuschlagen.

Der API-Assistent besteht aus den folgenden zwei Komponenten:
Fehler bei der Spezifikationsvalidierung
Optimieren Sie Ihre API, indem Sie Ihre Spezifikation unter OpenAPI3.0 analysieren und mögliche KI-basierte Korrekturen für Validierungsfehler generieren; siehe „Verwendung des API-Assistenten zur Fehlerbehebung “.
Erweiterungen der Spezifikation
Verbessern Sie Ihre API-Dokumentation, indem Sie Ihre API-Definition analysieren und Empfehlungen für Ihre Beschreibungen und Beispiele generieren; siehe „Verwenden des API-Assistenten zur Dokumentation Ihrer APIs “.
Draft comment: jendavidse@uk.ibm.com
We're calling this the API Assistant, and yet I don't see this term in the UI. I see "AI" as the title of the icon, and "AI recommendations" as the title of the panel. Can we put "API Assistant" as the title of the panel instead? Update: this query is still with design/prod mgt to consider. UI likely to completely change with the conversational API Assistant coming out in Dec 24.

Einschränkungen

Die Funktion API-Assistent unterliegt einer Ratenbegrenzung für Anrufe an den KI-Generator. Die beste Leistung erzielen Sie, wenn Sie den API-Assistenten für APIs von mittlerer Größe verwenden.

Darüber hinaus gelten die folgenden Einschränkungen:
  • Sie müssen einen " Premium subscription verwenden. Informationen zu den verschiedenen Abonnements und zum Upgrade finden Sie unter Kauf-, Abonnement- und Upgrade-Informationen.
  • Sie müssen online im API Manager arbeiten (das lokale Arbeiten im API Designer wird nicht unterstützt).
  • Ihre API-Definition muss der OpenAPI 3.0 Spezifikation entsprechen (OpenAPI 2.0 wird nicht unterstützt).