Ask Eddy AI API

Die Eddy AI Public API ist eine unschätzbare Funktion, die entwickelt wurde, um die Funktionalität und Flexibilität unserer Eddy AI Suchfunktion zu verbessern. Die Eddy AI Public API ist besonders nützlich für Unternehmen, die KI-gesteuerte Suchfunktionen direkt in ihre eigenen Plattformen oder Dienste integrieren möchten. Indem Sie Eddy AI in Ihr Produkt integrieren, bieten Sie den Nutzern die Möglichkeit, auf leistungsstarke Suchfunktionen zugreifen, ohne Ihre Dokumentationsseite besuchen zu müssen.

Diese API bietet größere Flexibilität bei der Anpassung der Benutzeroberfläche, sodass Sie Aspekte wie Farbe, Benennung und Platzierung so anpassen können, dass sie mit Ihrer Marke und Ihrem Nutzererlebnis übereinstimmen. Mit dieser nahtlosen Integration wird Eddy AI zu einer natürlichen Erweiterung Ihres Produkts, verbessert die Nutzerinteraktion und steigert die Sucheffizienz. Indem Sie die API-Endpunkte freistellen, können Sie sie in Ihre Plattformen integrieren, mühelos Antworten aus Eddy AI extrahieren und ein maßgeschneidertes Sucherlebnis erstellen.

HINWEIS

Um mehr über die von Eddy AI unterstützten Sprachen zu erfahren, klicken Sie hier.

Nutzung der öffentlichen API

1. Navigiere zu () in der linken Navigationsleiste im Knowledge base portal.

2. Im linken Navigationsfenster navigieren 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.

HINWEIS

1. Stellen Sie sicher, dass mindestens eines der Kontrollkästchen aktiviert ist. Andernfalls wird der KI-Schalter für die unterstützende Suche automatisch deaktiviert.

2. Wenn die öffentliche API nicht aktiviert ist, erhalten Sie bei der Nutzung der Ask Eddy AI API einen '500 Antwortcode-Fehler' oder einen '400 API-Zugriff deaktiviert Fehler'.

3. Jeder API-Aufruf reduziert deine Gesamtanzahl um eins.

3. Erstellen Sie ein Autorisierungs-API-Token.

HINWEIS

1. Im Knowledge Base-Portal navigieren Sie in der linken Navigationsleiste zu Einstellungen () ().

2. Im linken Navigationsfenster navigieren Sie zum Knowledge Base Portal > API-Tokens.

3. Klicken Sie auf Create API Token, geben Sie den Tokennamen ein und geben Sie die POST-Methode an.

4. Klicken Sie auf Erstellen und kopieren Sie das generierte API-Token.

4. Die API-Struktur findest du am API-Hub.

Probieren Sie die Eddy AI Public API in unseren API-Dokumenten aus

1. Navigiere zur Document360-API-Dokumentation.

2. Auf der rechten Seite der Seite klicken Sie auf den Abschnitt ' Probieren' .

3. Im Feld Token geben Sie das API-Token ein, das aus Ihrem Document360-Projekt generiert wurde.

4. Geben Sie die gewünschten Werte im Bereich "Body " ein. Das Standardanforderungsfeld erscheint wie folgt:

   1. Prompt: Geben Sie die Frage oder Anfrage ein.

   2. Versions-ID: Erhalten Sie die aktuelle Versions-ID.

   3. Sprachcode: Geben Sie den gewünschten Sprachcode für die Eingabe an.

5. Klicke auf Try it & See Response, und die Antwort wird generiert.

Probier die Eddy AI Public API in Swagger aus

1. Navigiere zum Swagger API-Hub. Unter Projektversionen findest du die Ask Eddy AI API.

2. Oben rechts im Swagger API-Hub klicken Sie auf Autorisieren.

3. Das Feld "Verfügbare Autorisierungen" erscheint und fordert Sie auf, das API-Token einzugeben.

4. Fügen Sie das API-Token in das Panel Verfügbare Autorisierungen ein und klicken Sie auf Autorisieren.

5. Nach der Autorisierung gehe ich zu Projektversionen > /v2/ProjectVersions/ask-Eddy AI und klicke auf Probieren.

6. Das Standardanforderungsfeld erscheint wie folgt:

• Prompt: Geben Sie die Frage oder Anfrage ein.

• Versions-ID: Erhalten Sie die aktuelle Versions-ID vom /v2/ProjectVersions Endpunkt.

  

• Sprachcode: Geben Sie den gewünschten Sprachcode an.

7. Klicken Sie auf Ausführen , um eine erfolgreiche Antwort mit allen erforderlichen Informationen zu erhalten.

HINWEIS

Wenn Sie eine Meldung über den Dienst nicht verfügbar erhalten, stellen Sie sicher, dass die öffentliche API in den Einstellungen aktiviert ist.

{
  "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
}