KI-Chat
Jede Jamdesk-Dokumentationswebsite bietet einen integrierten KI-Chatassistenten. Besucher stellen Fragen und erhalten Antworten mit Zitaten aus Ihrer Dokumentation.
Jede Jamdesk-Website bietet einen Chatassistenten, der Fragen von Besuchern anhand Ihrer Dokumentation beantwortet. Er findet relevante Abschnitte und sendet sie an Claude. Die Antwort wird mit Links zu den Quellseiten ausgegeben. Der Chat ist in jedem Tarif standardmäßig und ohne Zusatzkosten aktiviert.
Die Screenshots zeigen die Benutzeroberfläche auf Englisch.
So sieht der Chatassistent in Aktion aus:
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.
Funktionsweise
Bei jedem Build teilt Jamdesk Ihre Seiten in Abschnitte auf und speichert diese als durchsuchbare Embeddings.
Über die Schaltfläche „Ask AI“ (oder Cmd+I / Ctrl+I) wird auf jeder Seite ein Chatbereich geöffnet.
Jamdesk ruft relevante Abschnitte ab und sendet sie Claude als Kontext. Die Antwort wird mit Links zu den zitierten Quellseiten ausgegeben.
Funktionen
| Funktion | Details |
|---|---|
| Gestreamte Antworten | Antworten werden in Echtzeit ausgegeben |
| Zitatlinks | Jede Antwort verlinkt auf die Dokumentationsseiten, aus denen sie stammt |
| Mehrdeutigkeit auflösen | Bei einer Frage, die zu mehreren Themen passt, fragt die KI nach, welches Thema gemeint ist |
| Gesprächskontext | Verlauf mit 10 Nachrichten, gespeichert pro Browser-Tab |
| Vorschlagsfragen | Automatisch aus Ihrer Dokumentation generiert oder in docs.json festgelegt |
| Tastenkombinationen | Cmd+I / Ctrl+I zum Öffnen oder Schließen, Escape zum Schließen |
| Markdown-Darstellung | Codeblöcke, Tabellen und Listen werden in den Antworten dargestellt |
Konfiguration
Für den Chat ist keine Konfiguration erforderlich. Fügen Sie nur dann einen chat-Block zu docs.json hinzu, wenn Sie die Vorschlagsfragen ändern, die Schaltfläche umbenennen, ihr Symbol ändern oder den Chat deaktivieren möchten. Jede Einstellung hat einen Standardwert.
{
"chat": {
"enabled": true,
"starterQuestions": [
"How do I get started?",
"What API endpoints are available?"
]
}
}| Feld | Typ | Standardwert | Beschreibung |
|---|---|---|---|
enabled | boolean | true | Setzen Sie den Wert auf false, um die Schaltfläche „Ask AI“, den Chatbereich und die Tastenkombination auf Ihrer Website zu entfernen |
starterQuestions | string[] | automatisch generiert | Bis zu 4 Fragen, die beim Öffnen des Chatbereichs angezeigt werden (jeweils 5–200 Zeichen). Werden automatisch aus Ihrer Dokumentation generiert, wenn der Wert fehlt; setzen Sie den Wert auf [], um keine Fragen anzuzeigen |
label | string | "Ask AI" in der Sprache der Seite | Ersetzt „Ask AI“ auf der Chat-Schaltfläche, in der Kopfzeile des Chatbereichs und bei der Such-Tastenkombination. Bis zu 40 Zeichen. Gilt für alle Sprachen. |
icon | string | sparkles | Ein Font-Awesome-Symbolname, eine Bild-URL oder ein Pfad zu einem Bild in Ihrem Projekt. Ein Font-Awesome-Symbol übernimmt Ihre Akzentfarbe. Ein Bild wird unverändert angezeigt. Wählen Sie ein Symbol, das sich auf dunklem Hintergrund gut abhebt. |
Vorschlagsfragen
Vorschlagsfragen sind Prompts, die im Chatbereich angezeigt werden und sich mit einem Klick verwenden lassen, bevor ein Besucher etwas eingibt. Wenn starterQuestions in docs.json fehlt, generiert Jamdesk bei jedem Build Vorschlagsfragen aus Ihrer Dokumentation. Sie bleiben aktuell, wenn Ihre Dokumentation wächst.
Legen Sie eigene Fragen im Array starterQuestions fest. So können Sie häufige Fragen an Ihr Supportteam an den Anfang stellen:
{
"chat": {
"starterQuestions": [
"How do notifications work?",
"Tell me more about analytics"
]
}
}Legen Sie bis zu 4 Vorschlagsfragen mit jeweils 5 bis 200 Zeichen fest. Setzen Sie starterQuestions auf ein leeres Array ([]), um keine Fragen anzuzeigen.
Benutzerdefinierter Name und Symbol
Die Chat-Schaltfläche, die Kopfzeile des Chatbereichs und die Such-Tastenkombination zeigen standardmäßig „Ask AI“ und ein Funkel-Symbol an. Legen Sie label und icon passend zu Ihrem Produkt fest:
{
"chat": {
"label": "Acme Assistant",
"icon": "/images/assistant.svg"
}
}Die Bezeichnung ist in allen Sprachen Ihrer Website gleich. Ein Wert wie robot für icon ist ein Font-Awesome-Symbolname. Ein Wert, der mit http://, https:// oder / beginnt oder mit einer Bilddateiendung endet, wird als Bild behandelt.
Chat deaktivieren
Der Chat ist in jedem Tarif standardmäßig aktiviert. Setzen Sie enabled auf false, um ihn zu deaktivieren. Dadurch werden die Schaltfläche „Ask AI“, der Chatbereich und die Tastenkombination Cmd+I / Ctrl+I entfernt:
{
"chat": {
"enabled": false
}
}Das Deaktivieren des Chats wirkt sich nicht auf die Suche aus. KI-Chat und Suche sind separate Funktionen.
Einschränkungen
| Einschränkung | Wert |
|---|---|
| Maximale Nachrichtenlänge | 2.000 Zeichen |
| Maximale Antwortlänge | 2.048 Tokens |
| Ratenbegrenzung | 10 Anfragen / 60 Sekunden pro Besucher und Website |
| Gesprächsverlauf | 10 Nachrichten pro Tab |
| Vorschlagsfragen | Maximal 4 |
Der Chat funktioniert auf benutzerdefinierten Domains. Der /_chat-Endpoint ist same-origin. Er funktioniert auf jeder Domain, über die Ihre Dokumentation bereitgestellt wird.
Jamdesk teilt Ihre Seiten bei jedem Build in Abschnitte auf und speichert für jeden Abschnitt ein Vektor-Embedding. Die Frage eines Besuchers löst eine hybride Suche aus, die Keyword-Abgleich und semantische Ähnlichkeit kombiniert, um die relevantesten Abschnitte in Ihrer Dokumentation zu finden. Jamdesk sendet diese Abschnitte Claude als Kontext und weist Claude an, ausschließlich anhand der bereitgestellten Dokumentation zu antworten. Jamdesk ermittelt Zitate, indem Seitenverweise in Claudes Antwort mit den abgerufenen Abschnitten abgeglichen werden.
Wie geht es weiter?