Docsbook
Übersicht

KI-Chat

Der Docsbook-KI-Chat ist ein Widget auf Ihrer Dokumentationsseite, das die Frage eines Lesers anhand des Inhalts dieser Dokumentation beantwortet. Ein Leser stellt eine Frage, der Server durchsucht Ihre Seiten, ruft die passenden Seiten ab und streamt eine Antwort zurück, in der diese zitiert werden.

Bei jedem Dokumentationsassistenten ist nicht entscheidend, dass er Antworten liefert – sondern wie er reagiert, wenn er es nicht kann. Diese Seite ist der Vertrag für beide Seiten. Die Pipeline selbst wird unter Antwortqualität beschrieben.

Was Sie erhalten#

  • Eine Antwort auf der Seite, kein Ticket. Ein Leser, der die Frage anders formuliert als Ihre Überschrift, gelangt trotzdem zu der Seite, die sie beantwortet.
  • Eine sichtbare Spur. Das Widget gibt Found N results aus, danach eine Reading <page>-Zeile pro geöffneter Seite. Jede Zeile ist ein Link, sodass ein skeptischer Leser die Quelle selbst überprüfen kann.
  • Zitate unter der Antwort. Ein Zitat bleibt nur erhalten, wenn der Server diese Seite tatsächlich für diese Frage abgerufen hat oder die Antwort ihren Pfad inline zitiert hat. Ein Pfad, den das Modell weder gelesen noch zitiert hat, wird entfernt, bevor der Leser ihn sieht.
  • Nachfragen. Aus der Antwort werden drei kurze Folgefragen generiert und als Schaltflächen angeboten.
  • Eine Aufzeichnung dessen, was fehlgeschlagen ist. Fragen, die der Assistent nicht beantworten konnte, werden zu einem Bericht über unbeantwortete Fragen und einem chat.no_answer-Webhook. Dieser enthält die Liste der Seiten, die Sie noch nicht geschrieben haben.

Was der Assistent nicht tun wird#

Er wird nicht Warum
Aus dem eigenen vortrainierten Wissen des Modells antworten Der Anweisungsblock verbietet, auf allgemeines Wissen zurückzugreifen, um einen Begriff zu definieren oder eine Lücke zu füllen, die Ihre Dokumentation nicht abdeckt
Eine Seite zitieren, die es weder gelesen noch zitiert hat Eine Quellenangabe bleibt nur dann bestehen, wenn der Pfad inline in der Antwort zitiert wurde oder es sich um eine Seite handelt, die der Server tatsächlich abgerufen hat. Die abgerufene Hälfte ist konstruktionsbedingt fundiert, die Inline-Hälfte jedoch nicht – siehe Antwortqualität
Einen Einrichtungsablauf erfinden Bei „Wie richte ich X ein?“ muss es auf einen Satz in Ihren Inhalten verweisen, der einen konkreten Menüpfad, eine Schaltfläche oder einen Schritt benennt. Eine beiläufige Erwähnung von X ist kein Einrichtungsablauf, und es ist angewiesen, dies auch so zu sagen
Eine angegebene Voraussetzung auslassen Wenn eine Seite einen erforderlichen Tarif, eine Rolle, einen vorherigen Schritt, eine Version oder ein Kontingent nennt, muss die Antwort dies enthalten – auch wenn diese Anforderung nur in der Einleitung der Seite genannt wird
Eine kostenlose Funktion mit ihrem kostenpflichtigen Upgrade vermischen Seiten, die verwandte, aber unterschiedliche Dinge beschreiben, werden absichtlich getrennt gehalten
Einen Anker erraten Das Linkziel für eine zitierte Überschrift wird vom Server mit demselben Slugifier berechnet, der Ihre Seite rendert, und niemals vom Modell übernommen

Wie wird eine Antwort erstellt?#

Kurzfassung; die Details finden Sie unter Antwortqualität.

  1. Optionaler Pre-Hook. Wenn Sie einen registriert haben, empfängt Ihr Endpunkt die Frage zuerst und kann sie blockieren oder Kontext einschleusen. Siehe Chat-Hooks.
  2. Abruf. Vektorsuche und die PostgreSQL-Volltextsuche werden beide ausgeführt und ihre Ergebnisse zusammengeführt — insgesamt auf fünf Seiten begrenzt. Zwei lexikalische Fallbacks decken Korpora ohne Vektorindex ab.
  3. Abrufen. Jede ausgewählte Seite wird aus Ihrem Repository in dessen Standard-Branch gelesen und auf 12.000 Zeichen gekürzt, wobei der Anfang und das Ende erhalten bleiben.
  4. Generierung. Die Seiten, Ihr System-Prompt und die Grounding-Regeln werden an das Modell übergeben; die Antwort wird als Markdown zusammen mit einem Zitationsarray zurückgestreamt.
  5. Zitationsfilterung. Referenzen werden anhand der tatsächlich gelesenen Seiten überprüft, und Anker werden serverseitig neu berechnet.
  6. Aufzeichnung. Tokenanzahlen und Anbieterkosten werden in Ihr Nutzungsprotokoll geschrieben; chat.question_asked wird ausgelöst und chat.no_answer ebenfalls, wenn die Antwort zugab, dass sie es nicht wusste.

Was Sie konfigurieren können#

Steuerung Was sie ändert Wo
System-Prompt Ersetzt die standardmäßige Anweisung durch Ihre Ausdrucksweise und Regeln. Sie wird zusätzlich zu den Grounding-Regeln hinzugefügt, nicht an ihrer Stelle Chat-Einstellungen
Vorgeschlagene Fragen Die Start-Prompts im leeren Zustand – der wirkungsvollste Text im Widget, weil sie einem Leser mitteilen, wofür der Assistent gedacht ist Chat-Einstellungen
Call-to-Action-URL Der Assistent beantwortet zuerst die Frage und verweist dann in einem Satz auf diesen Link – nur wenn der Leser etwas bewertet, vergleicht oder nach Einschränkungen, Preisen oder Tarifen fragt, und niemals mehr als einmal pro Antwort Chat-Einstellungen
Modell Welches Modell die Fragen der Leser beantwortet. In jedem Tarif kostenlos Chat-Einstellungen
Pre-/Post-/Streaming-Hooks Ihre eigenen HTTPS-Endpunkte rund um jede Antwort Chat-Hooks
Semantischer Index Bedeutungsbasierte Suche zusätzlich zum Keyword-Matching Float Widget → AI Chat → Semantische Suche

Ein Assistent, der jede Antwort mit einem Preislink beendet, wird nicht mehr als vertrauenswürdig wahrgenommen, wodurch mehr Conversions verloren gehen als gewonnen werden – deshalb ist der Call-to-Action als Einschränkung formuliert, wann er angeboten werden soll, und nicht als dauerhafte Anweisung, dafür zu werben.

Welches Modell führt den Chat aus?#

Der verwaltete Standard des Leser-Chats ist openai/gpt-4o-mini über OpenRouter: ein Kontextfenster mit 128.000 Tokens und eine Ausgabebegrenzung von 16.384 Tokens gemäß der Modellreferenz von OpenAI. Du kannst stattdessen in jedem Tarif ein beliebiges Modell aus dem Chat-Katalog auswählen. Der Auswahlbereich zeigt neben jedem Modell dessen Preis pro einer Million Tokens an.

Es gibt zwei Modelleinstellungen, weil zwei verschiedene Assistenten im Einsatz sind und separat gemessen werden:

  • KI-Besucher-Chatmodell — beantwortet die Fragen deiner Leser.
  • Admin & KI-Agentenmodell — führt den Assistenten in deinem Dashboard aus, der Tools aufruft und deine Dokumente bearbeitet.

Sie sind bewusst nicht in einer Einstellung zusammengefasst. Docsbook veröffentlichte einmal eine Version, in der die Admin-Schleife aufgrund eines nicht weitergereichten Parameters unbemerkt den Standard des Leser-Chats verwendete. Dadurch sahen beide Oberflächen wochenlang von außen identisch aus. Ein Modell, das für Tool-Aufrufe gemessen wurde, ist nicht automatisch das richtige Modell für Fragen und Antworten von Lesern – und umgekehrt. Die Trennung der Konstanten sorgt dafür, dass jede Auswahl überprüfbar bleibt.

Auf dem Schlüssel von Docsbook werden nur Modelle aus dem veröffentlichten Katalog akzeptiert, da die Kosten zum tatsächlichen Preis des Modells abgerechnet werden — ein nicht erkanntes Modell würde zu einem Tarif berechnet, der dir nie angezeigt wurde. Wenn du deinen eigenen Anbieterschlüssel verwendest, kannst du jedes von deinem Anbieter angebotene Modell angeben. Die Nutzung wird dann zu dem Preis deines Anbieters über deinen Schlüssel abgerechnet und nicht über dein Docsbook-Guthaben.

Verfügbarkeit und Kosten#

Der KI-Chat für Leser ist eine Pro-Funktion. In einem Free-Projekt wird die Frage eines Besuchers abgewiesen, bevor ein Modell aufgerufen wird, unabhängig davon, welchen Schlüssel das Projekt besitzt — die Sperre ist eine Entscheidung auf Tarifebene, keine Kostenentscheidung, daher wird sie durch die Verwendung eines eigenen Schlüssels nicht aufgehoben. Die eigenen Fragen des Besitzers im Admin-Chat bleiben in jedem Tarif möglich. Die aktuellen Tarife finden Sie auf der Preisseite.

Drei Dinge im Chat werden dem Projektguthaben angerechnet: eine Antwort an einen Leser, das Erstellen oder erneute Erstellen des semantischen Index (einschließlich der Einbettung jeder eingehenden Frage) sowie ein über den Chat gestarteter Agentenlauf. Das Hosten des Widgets, die Bereitstellung der Seite, die Stichwortsuche, Seitenfeedback und Hook-Aufrufe werden nicht angerechnet.

Abgerechnet zu werden und ein Modell aufzurufen sind nicht dasselbe, und es ist wichtig zu wissen, in welche Kategorie die einzelnen Vorgänge fallen. Zwei Modellaufrufe im Leserpfad werden derzeit nicht berechnet: die drei Folgefragen unter einer Antwort und die agentische Suchschleife, die nur ausgeführt wird, wenn alle Retriever leer zurückkommen. Ein Modellaufruf, der nicht Teil des Leserpfads ist, wird berechnet: der Prüfer, der die Spalte Beantwortet in Ihrem Chat-Tab ausfüllt und als KI-Arbeit auf Besitzerseite berechnet wird.

Wenn das Guthaben aufgebraucht ist, wird der Chat angehalten, anstatt weitere Kosten zu verursachen. Die eigene Antwort des Servers unterscheidet zwischen einem Tariflimit und einer von Ihnen selbst festgelegten Obergrenze, und nur Ersteres wird als Treffer der Bezahlschranke gezählt — eine selbst auferlegte Quellenbegrenzung erscheint daher in Ihrem Trichter niemals als Nachfrage nach einem Upgrade. Dem Leser wird in beiden Fällen mitgeteilt, dass der Chat pausiert wurde.

Was ein Leser sieht, wenn etwas fehlschlägt#

Situation Was der Leser erhält
Kein KI-Chat für diese Website verbunden Eine klare Erklärung mit der Bitte, den Eigentümer der Website zu kontaktieren. Niemals ein Stacktrace
Projekt im Free-Tarif Nichts. Die Chat-Oberfläche wird überhaupt nicht dargestellt, daher gibt es weder eine Schaltfläche noch eine Nachricht – der Leser sieht eine Dokumentationswebsite ohne Assistenten
Guthaben aufgebraucht Der Chat pausiert und teilt dies mit
Die Suche hat nichts gefunden Eine Antwort, die klar sagt, dass die Dokumentation dies nicht abdeckt – und ein Eintrag in Ihrem Bericht zu unbeantworteten Fragen
Ihr Pre-Hook hat die Frage blockiert Eine allgemeine Fehlermeldung. Siehe die Einschränkung unten
Modell- oder Netzwerkfehler „Etwas ist schiefgelaufen. Bitte versuchen Sie es erneut.“, in der Sprache des Lesers

Einschränkungen#

  • Eine blockierte Frage zeigt dem Leser nicht den Grund an. Der reason-String des Pre-Hooks wird im Antwort-Stream gesendet, aber das Widget der Dokumentations-Website rendert stattdessen die allgemeine Fehlermeldung. Unter „Frage“ wird das Feld übermittelt und kann von einem benutzerdefinierten Frontend gelesen werden, aber nicht vom mitgelieferten Widget. Behandle reason bis zur Behebung als Wert für deine eigenen Protokolle.
  • Der Multiplayer-Chat ist implementiert, aber nicht aktiviert. Die Einladungsoberfläche, die Anwesenheitsschaltfläche und die API-Routen sind vorhanden; der Transport fehlt jedoch, sodass die Aktivierung einer gemeinsamen Sitzung „Vorübergehend nicht verfügbar“ zurückgibt. Plane nicht damit.
  • Der Detektor für unbeantwortete Fragen verwendet einen englischen Musterabgleich. Eine in einer anderen Sprache verfasste Ablehnung wird nicht erkannt, sodass chat.no_answer und der Bericht zu unbeantworteten Fragen auf nicht englischsprachigen Websites zu niedrige Werte ausweisen.
  • Antwort-Feedback und Seiten-Feedback sind unterschiedliche Reihen. Ein Daumen nach unten bei einer Antwort ist nicht dasselbe Ereignis wie ein Daumen nach unten bei einer Seite; unter Seiten-Feedback erfährst du, was jeweils erreicht wird.
  • Keine veröffentlichte Genauigkeitsangabe. Docsbook macht keine Angaben zum prozentualen Anteil der Antwortgenauigkeit. Antwortqualität erläutert stattdessen, was gemessen wird und warum wir keine Zahl nennen.
  • Das Standardmodell für Leser kann vom Anbieter geändert werden. Kontextfenster, Ablehnungsverhalten und Preis liegen in dessen Verantwortung; der Abruf- und Zitiermechanismus liegt in unserer.
  • Antwortqualität — die vollständige Pipeline für Retrieval und Grounding inklusive Quellen.
  • Quellen — was der Assistent über Ihre eigenen Seiten hinaus lesen darf.
  • Chat-Hooks — jede Antwort blockieren, anreichern oder spiegeln.
  • Suche — der Schlagwortindex, den der Chat mit Ihrem Suchfeld teilt.
  • MCP-Server — Chateinstellungen über Claude Code oder Cursor verwalten.
  • Preise — worauf eine Antwort basiert.

War diese Seite hilfreich?