Fragen Sie die Eddy AI API

Pläne, die die Verwendung der Ask Eddy AI API unterstützen

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. Durch die Einbettung von Eddy AI in Ihr Produkt bieten Sie Benutzern die Möglichkeit, auf leistungsstarke Suchfunktionen zuzugreifen, ohne Ihre Dokumentationsseite besuchen zu müssen.

Diese API bietet eine größere Flexibilität bei der Anpassung der Benutzeroberfläche und ermöglicht es Ihnen, Aspekte wie Farbe, Benennung und Platzierung an Ihre Marke und Benutzererfahrung anzupassen. Mit dieser nahtlosen Integration wird Eddy AI zu einer natürlichen Erweiterung Ihres Produkts, die die Benutzerinteraktionen verbessert und die Sucheffizienz verbessert. Durch die Offenlegung der API-Endpunkte können Sie sie in Ihre Plattformen integrieren, mühelos Antworten aus Eddy AI extrahieren und ein individuelles Sucherlebnis erstellen.

ANMERKUNG

Neben Englisch (en-US, en-GB) unterstützt die Eddy AI Public API fünf weitere Sprachen, wie z. B.

Französisch (fr)

Spanisch (es)

Deutsch (de)

Norwegisch (nein)

Niederländisch (nl)

Verwenden der öffentlichen API

1. Navigieren Sie im Wissensdatenbank-Portal zu Einstellungen () > KI-Funktionen > Eddy AI .

2. Aktivieren Sie in der KI-Hilfssuche das Kontrollkästchen Öffentliche API .

ANMERKUNG

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

2. Wenn die öffentliche API nicht aktiviert ist, erhalten Sie bei der Verwendung der Ask Eddy AI API einen Fehler mit 500 Antwortcodes.

3. Jeder API-Aufruf reduziert die Anzahl Ihrer Gesamtguthaben um eins.

3. Erstellen Sie ein Autorisierungs-API-Token.

ANMERKUNG

1. Navigieren Sie im Knowledge Base-Portal zu Einstellungen () > Knowledge Base-Portal > API-Token.

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

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

4. Die API-Struktur finden Sie auf der API hub.

Testen Sie die Eddy AI Public API in unserer API-Dokumentation

1. Navigieren Sie zum Document360- API documentation.

2. Klicken Sie rechts auf der Seite auf den Abschnitt Ausprobieren .

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

4. Geben Sie die gewünschten Werte im Abschnitt Text ein. Das Standardanforderungsfeld wird wie folgt angezeigt:

   1. Eingabeaufforderung: Geben Sie die Frage oder Suchanfrage ein.

   2. Versions-ID: Rufen Sie die aktuelle Versions-ID ab.

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

5. Klicken Sie auf Ausprobieren und Antwort anzeigen und die Antwort wird generiert.

Probieren Sie die öffentliche API von Eddy AI in Swagger aus

1. Navigieren Sie zum Swagger API hub. Unter Projektversionen finden Sie die Ask Eddy AI API.

2. Klicken Sie oben rechts im Swagger-API-Hub auf Autorisieren.

3. Der Bereich Verfügbare Autorisierungen wird angezeigt, in dem Sie aufgefordert werden, das API-Token einzugeben.

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

5. Navigieren Sie nach der Autorisierung zu > /v2/ProjectVersions/ask-Eddy AI Projektversionen und klicken Sie auf Ausprobieren.

6. Das Standardanforderungsfeld wird wie folgt angezeigt:

• Eingabeaufforderung: Geben Sie die Frage oder Suchanfrage ein.

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

  

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

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

ANMERKUNG

Wenn Sie die Meldung erhalten, dass der Dienst nicht verfügbar ist, 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
}