Eddy AI ist in deine veröffentlichte API-Referenz integriert, sodass Entwickler Fragen zu einem Endpunkt stellen und Antworten erhalten können, ohne die Dokumentation zu verlassen. Anstatt allein aus den Parametern, dem Schema und dem Codebeispiel zusammenzusetzen, wie ein Endpunkt funktioniert, kann ein Entwickler Eddy direkt fragen – wie sich der Endpunkt verhält, welche Authentifizierung benötigt oder nach einer Codeprobe in einer bestimmten Sprache – und eine Antwort erhalten, die in der eigenen Spezifikation dieses Endpunkts basiert.
Dieser Artikel erklärt, wie Entwickler Eddy AI in der API-Referenz verwenden und wie Sie es für Ihre API-Dokumentation aktivieren können. Für einen allgemeinen Überblick über die Lesererfahrung siehe API-Grundlagen.
Wo man Eddy AI finden kann
Eddy AI ist direkt über die Panels auf einer Endpunktseite verfügbar. Achten Sie auf das Ask Eddy KI-Symbol bei jedem der folgenden Punkte:
- Codepanel – fragen Sie nach dem Wunschbeispiel, zum Beispiel um es zu erklären oder in eine andere Sprache umzuwandeln.
- Anfrage-Panel – frag nach der Anfrage, die du in Try It! einbaust.
- Antwortpanel – Fragen Sie nach der Antwort, zum Beispiel was ein bestimmtes Fachgebiet oder ein bestimmter Status bedeutet.
Ein Klicken auf das Symbol öffnet das Eddy-AI-Panel, das bereits auf den von dir angezeigten Endpunkt ausgerichtet ist.
Eine Frage stellen
Wenn du Eddy AI öffnest, kannst du entweder eine der vorgeschlagenen Aufgaben auswählen oder deine eigene Frage eingeben.
Die vorgeschlagenen Prompts sind:
- Erkläre diesen Endpunkt
- Zeigen Sie ein Curl-Beispiel
- Welche Authentifizierung benötigt dies?
Um etwas anderes zu stellen, tippen Sie Ihre Frage in das Feld "Stelle eine Frage..." ein und reichen Sie sie ein. Eddy antwortet mit der Spezifikation des aktuellen Endpunkts, sodass seine Antworten den realen Pfad, die Parameter, die Authentifizierung und das Schema dieses Endpunkts widerspiegeln – keine generischen Beispiele.
Wenn man beispielsweise in einer bestimmten Sprache nach einem Anfrage-Beispiel fragt, wird ein für diesen Endpunkt erstellter einsatzbereiter Ausschnitt zurückgegeben, einschließlich der korrekten URL und Authentifizierung, mit einer Kontrolle zum Kopieren des Codes.
Eddy AI für Ihre API-Dokumentation aktivieren
Eddy AI muss für deine API-Dokumentation aktiviert sein, bevor sie in der veröffentlichten Referenz erscheint. Dies wird von einem Administrator im Knowledge Base-Portal konfiguriert.
- Gehe zu Einstellungen > KI-Einstellungen > Eddy AI-Einstellungen.
- Unter dem Abschnitt Search Suite wählen Sie das Kontrollkästchen für die API-Dokumentation aus.
- Speichern Sie Ihre Änderungen.
Sobald aktiviert, erscheint das Ask Eddy AI-Symbol in den Endpunkt-Panels in deiner veröffentlichten API-Referenz.
Dinge, die man beachten sollte
- Eddy-AI-Antworten sind auf den Endpunkt abgegrenzt. Die Antworten werden aus der Spezifikation des von Ihnen betrachteten Endpunkts generiert und spiegeln daher die tatsächlichen Details dieses Endpunkts wider, anstatt generische Beispiele.
- Die Nutzung von KI verbraucht Credits. Je nach Ihrem Plan kann die Nutzung von Eddy AI auf die AI-Kreditzuwendung Ihres Projekts angerechnet werden. Überprüfen Sie die KI-Kreditbedingungen Ihres Plans, wenn Sie mit starker Nutzung rechnen.
FAQ
Wo erscheint Eddy AI in der API-Referenz?
Das Ask Eddy KI-Symbol erscheint in den Code-, Anfrage- und Antwortfeldern einer Endpunktseite. Ein Klick darauf öffnet das Eddy-AI-Panel, das auf diesen Endpunkt zugeschnitten ist.
Was kann ich Eddy AI fragen?
Sie können eine der vorgeschlagenen Eingaben verwenden – Erklären Sie diesen Endpunkt, zeigen Sie ein Curl-Beispiel oder Welche Authentifizierung benötigt diese Authentifizierung? – oder tippe deine eigene Frage. Eddy antwortet mit der aktuellen Spezifikation des Endpunkts, sodass dessen Antworten den realen Weg, die Parameter und die Authentifizierung dieses Endpunkts widerspiegeln.
Warum sehe ich das Ask Eddy AI-Symbol nicht in meiner API-Referenz?
Eddy AI muss zuerst für die API-Dokumentation aktiviert werden. Ein Administrator kann es unter Einstellungen > KI-Einstellungen > Eddy AI-Einstellungen aktivieren, indem er das Kontrollkästchen für die API-Dokumentation im Bereich Search Suite auswählt.