Ask Eddy AI API

Die Eddy AI Public API ermöglicht es Ihnen, die unterstützende Suche von Eddy AI direkt in Ihre eigene Plattform oder Ihren Dienst einzubetten, sodass Nutzer Ihre Wissensdatenbank absuchen können, ohne Ihre Dokumentationsseite besuchen zu müssen. Sie rufen den API-Endpunkt mit einer Aufforderung auf und erhalten eine KI-generierte Antwort, die aus den Inhalten Ihrer Wissensdatenbank stammt. Das gibt Ihnen die volle Kontrolle über die Suchoberfläche – einschließlich ihres Aussehens, ihres Erscheinens und ihres Verhaltens innerhalb Ihres Produkts. Die API ist über den Document360 API-Hub verfügbar.

Wann sollte man die Eddy AI Public API verwenden

• Eingebettete Suche in Ihrem Produkt – Antworten der Wissensdatenbank werden in Ihrer Anwendungsoberfläche angezeigt, ohne Benutzer auf eine separate Dokumentationsseite umzuleiten.
• Individuelle Suchoberflächen – erstellen Sie ein Sucherlebnis, das zum Farbschema, der Terminologie und dem Layout Ihrer Marke passt.
• Automatisierte Support-Workflows – integrieren Sie Eddy AI in Chatbots, Ticketsysteme oder Onboarding-Flows, die Ihre Wissensdatenbank programmatisch abfragen.

Bevor du anfängst

• Die Eddy AI Public API muss in Ihren Projekteinstellungen aktiviert sein (siehe Wie man die öffentliche API aktiviert).
• Du brauchst ein API-Token mit aktivierter POST-Methode (siehe Wie man ein API-Token erstellt unten).
• Der KI-Umschalter für unterstützende Suche benötigt, dass mindestens ein Kontrollkästchen (öffentliche API oder andere) ausgewählt bleibt – das Abwählen aller Kontrollkästchen schaltet automatisch den Umschalter aus.

Wie man die öffentliche API aktiviert

1. Im Knowledge Base-Portal wählen Sie in der linken Navigationsleiste Einstellungen (⚙) aus.
2. Im linken Navigationsfenster gehen Sie zu KI-Funktionen > Eddy AI.
3. Erweitern Sie die KI-Suchsuite , Akkordeon.
4. Im Bereich KI-Assistive Search wählen Sie das Kästchen Public API aus.

Wie man einen API-Token erstellt

Du brauchst ein API-Token, um Anfragen an der Eddy AI Public API zu authentifizieren.

1. Im Knowledge Base-Portal wählen Sie in der linken Navigationsleiste Einstellungen (⚙) aus.
2. Im linken Navigationsfenster gehen Sie zum Knowledge Base-Portal > API-Tokens.
3. Klicken Sie auf API-Token erstellen, geben Sie einen Token-Namen ein und setzen Sie die Methode auf POST.
4. Klicken Sie auf Erstellen, kopieren Sie das generierte API-Token und speichern Sie es sicher.

Wie man die API testet

Sie können die Eddy AI Public API auf zwei Arten testen – über die Document360 API-Dokumentation oder über den Swagger API-Hub.

Test über API-Dokumentation

1. Gehe zur Dokumentation der Document360 API.
2. Auf der rechten Seite der Seite wählen Sie den Abschnitt " Probieren Sie es ".
3. Im Token-Feld geben Sie Ihr API-Token ein.
4. Füllen Sie die Körperfelder aus:

5. Klicke auf Try it und sieh die Antwort. Die KI-generierte Antwort erscheint unten.

Test mit Swagger

1. Geh zum Swagger API-Hub. Die Ask Eddy AI API ist unter Projektversionen aufgeführt.

2. Oben rechts klicken Sie auf Autorisieren.

3. Im Panel Verfügbare Autorisierungen fügen Sie Ihr API-Token ein und klicken Sie auf Autorisieren.

4. Navigiere zu Projektversionen > /v2/ProjectVersions/ask-Eddy AI und klicke auf 'Mal probieren'.

   Das Standardanforderungsfeld erscheint mit folgenden Feldern zum Ausfüllen:

Um Ihre Versions-ID abzurufen, rufen Sie zuerst den /v2/ProjectVersions Endpunkt auf:

5. Klicken Sie auf Ausführen. Eine erfolgreiche Antwort enthält die KI-generierte Antwort und Details zum Quellenartikel.

Best Practices

• Speichern Sie API-Token sicher – behandeln Sie Ihr API-Token als Geheimnis. Stellen Sie es nicht in clientseitigen Code oder öffentlichen Repositorien bereit. Rotiere es, wenn es beeinträchtigt ist.
• Verwenden Sie den richtigen ID-Typ für Ihren Inhalt – Standardartikel verwenden articleID, aber Seitenkategorie-Artikel erfordern categoryID. Mit der falschen ID werden Nullfelder in der Antwort zurückgegeben. Siehe die FAQ für Details.
• Geben Sie den Sprachcode explizit an – geben Sie immer den richtigen Sprachcode im Anforderungskörper weiter, damit Eddy AI die richtige Sprachversion Ihrer Wissensdatenbank durchsucht.
• Fehlerantworten behandeln – implementieren Sie Fehlerbehandlungen für 400 (API-Zugriff deaktiviert) und 500 (Servicefehler) Antworten. Beide zeigen typischerweise an, dass das Kästchen für die öffentliche API nicht aktiviert ist.

FAQ

{
"category_id": "_categoryid",

"category_title": "Title",

"category_slug": "slug",

"version_name": "v1",

"version_slug": "v1",

"article_id": null,

"article_title": null,

"article_slug": null,

"version_display_name": null

}