Jamdesk Documentation logo

KI-Chat

Jede Jamdesk-Dokumentationsseite enthält einen integrierten KI-Chat, der Fragen mit Antworten und Quellenangaben aus Ihrer Dokumentation beantwortet.

Jede Jamdesk-Seite enthält einen Chat-Assistenten, der Besucherfragen anhand Ihrer Dokumentation beantwortet. Er ruft relevante Abschnitte ab, sendet sie an Claude und streamt eine Antwort mit Links zu den Quellseiten.

Die Screenshots zeigen die Benutzeroberfläche auf Englisch.

Hier sehen Sie den Chat-Assistenten in Aktion:

Anwendungsfälle

Ein Entwickler, der Ihre API integriert, fragt „Wie authentifiziere ich Anfragen?“ und erhält die genauen Schritte mit einem Codebeispiel sowie einen Link zur Quellseite.

So funktioniert es

1
Build erstellt Indizes Ihrer Dokumentation

Bei jedem Build teilt Jamdesk Ihre Seiten in Abschnitte auf und speichert sie als durchsuchbare Embeddings.

2
Besucher stellt eine Frage

Die Schaltfläche „Ask AI“ (oder Cmd+I / Ctrl+I) öffnet auf jeder Seite ein Chatfenster.

3
KI beantwortet Fragen anhand Ihrer Dokumentation

Relevante Abschnitte werden abgerufen, als Kontext an Claude gesendet und die Antwort mit Quellenlinks zu den Quellseiten zurückgestreamt.

Funktionen

FunktionDetails
Gestreamte AntwortenAntworten treffen in Echtzeit ein
QuellenlinksJede Antwort verlinkt auf die Dokumentationsseiten, aus denen sie stammt
DisambiguierungWenn eine Frage zu mehreren Themen passt, fragt die KI, welches Thema der Besucher meint
GesprächskontextVerlauf mit 10 Nachrichten, pro Browser-Tab gespeichert
StartfragenAutomatisch aus Ihrer Dokumentation generiert oder in docs.json selbst festgelegt
TastaturkürzelCmd+I / Ctrl+I zum Ein- und Ausschalten, Escape zum Schließen
Markdown-DarstellungCodeblöcke, Tabellen und Listen werden innerhalb der Antworten dargestellt

Leerer Zustand des Chatfensters mit Startfragen

Konfiguration

Der Chat funktioniert ohne erforderliche Konfiguration sofort. Fügen Sie nur dann einen chat-Block zu Ihrer docs.json hinzu, wenn Sie die Startfragen anpassen oder den Chat deaktivieren möchten. Das Feld chat ist optional, und beide Einstellungen haben sinnvolle Standardwerte.

docs.json
{
  "chat": {
    "enabled": true,
    "starterQuestions": [
      "How do I get started?",
      "What API endpoints are available?"
    ]
  }
}
FeldTypStandardwertBeschreibung
enabledbooleantrueAuf false setzen, um die Schaltfläche „Ask AI“, das Chatfenster und das Tastaturkürzel von Ihrer Website zu entfernen
starterQuestionsstring[]automatisch generiertBis zu 4 Fragen, die beim Öffnen des Fensters angezeigt werden (jeweils 5-200 Zeichen). Wenn das Feld fehlt, werden sie automatisch aus Ihrer Dokumentation generiert; auf [] setzen, um keine anzuzeigen

Startfragen

Startfragen sind vorgeschlagene Eingaben, die im Chatfenster angezeigt werden, bevor ein Besucher etwas eingibt: Beispiele, die mit einem Klick ausgewählt werden können und Hinweise darauf geben, was gefragt werden kann. Wenn Sie starterQuestions in Ihrer docs.json weglassen, generiert Jamdesk sie bei jedem Build automatisch aus Ihrer Dokumentation, damit sie relevant bleiben, wenn Ihre Dokumentation wächst.

Um eigene Fragen festzulegen, tragen Sie sie in das Array starterQuestions ein. Das ist praktisch, wenn Ihr Supportteam immer wieder dieselben Fragen beantwortet und Sie diese zuerst anzeigen möchten:

docs.json
{
  "chat": {
    "starterQuestions": [
      "How do notifications work?",
      "Tell me more about analytics"
    ]
  }
}

Sie können bis zu 4 Startfragen mit jeweils 5 bis 200 Zeichen festlegen. Um überhaupt keine Startfragen anzuzeigen, setzen Sie starterQuestions auf ein leeres Array ([]).

Chat deaktivieren

Der Chat ist standardmäßig in jedem Tarif aktiviert. Um ihn zu deaktivieren, setzen Sie enabled auf false. Dadurch werden die Schaltfläche „Ask AI“, das Chatfenster und das Tastaturkürzel Cmd+I / Ctrl+I entfernt:

docs.json
{
  "chat": {
    "enabled": false
  }
}

Die Deaktivierung des Chats wirkt sich nicht auf die Suche aus. KI-Chat und Suche sind getrennte Funktionen, sodass Ihre Dokumentation auch bei deaktiviertem Chat vollständig durchsuchbar bleibt.

Einschränkungen

EinschränkungWert
Maximale Nachrichtenlänge2,000 Zeichen
Maximale Antwortlänge2,048 Tokens
Ratenbegrenzung10 Anfragen / 60 Sekunden pro Besucher und Website
Gesprächsverlauf10 Nachrichten pro Tab
Startfragenmaximal 4

Der Chat funktioniert auf benutzerdefinierten Domains. Der /_chat-Endpoint ist same-origin und funktioniert daher auf jeder Domain, unter der Ihre Dokumentation bereitgestellt wird.

Bei jedem Build teilt Jamdesk Ihre Seiten in Abschnitte auf und speichert für jeden Abschnitt Vektor-Embeddings. Wenn ein Besucher eine Frage stellt, führt das System eine hybride Suche durch (eine Kombination aus Keyword-Abgleich und semantischer Ähnlichkeit), um die relevantesten Abschnitte in Ihrer gesamten Dokumentation zu finden. Diese Abschnitte werden mit Anweisungen, ausschließlich anhand der bereitgestellten Dokumentation zu antworten, als Kontext an Claude gesendet. Quellenangaben werden extrahiert, indem Seitenverweise in der Antwort von Claude mit den abgerufenen Abschnitten abgeglichen werden.

Wie geht es weiter?

llms.txt

Automatisch generierter Seitenindex für KI-Tools

MCP Server

KI-Tools ermöglichen, Ihre Dokumentation programmgesteuert zu durchsuchen und abzufragen

docs.json-Referenz

Alle Konfigurationsfelder einschließlich der Chat-Einstellungen

So funktioniert Jamdesk

Die Build-Pipeline, die die Chat-Indizierung ermöglicht