Der Assistent ist bei den Pro- und Custom-Tarifen automatisch aktiviert.

​
Über den Assistenten

Der Assistent beantwortet Fragen zu Ihrer Dokumentation über natürliche Sprachabfragen. Er ist direkt in Ihre Dokumentationsseite eingebettet und bietet Nutzerinnen und Nutzern sofortigen Zugriff auf kontextbezogene Hilfe. Der Assistent verwendet agentisches RAG (Retrieval-Augmented Generation) mit Tool-Aufrufen, betrieben von Claude Sonnet 4. Wenn Nutzerinnen und Nutzer Fragen stellen, führt der Assistent Folgendes aus:
  • Sucht und ruft relevante Inhalte aus Ihrer Dokumentation ab, um präzise Antworten zu liefern.
  • Zitiert Quellen und stellt navigierbare Links bereit, die direkt zu den referenzierten Seiten führen.
  • Generiert kopierbare Codebeispiele, um bei der Umsetzung von Lösungen aus Ihrer Dokumentation zu helfen.
Jede an den Assistenten gesendete Nachricht zählt auf das Nachrichtenkontingent Ihres Tarifs. Wenn Sie Ihr Kontingent überschreiten, fallen für zusätzliche Nachrichten Mehrkosten an. Sie können Ausgabegrenzen festlegen oder den Assistenten deaktivieren, sobald Sie Ihr Kontingent erreichen. Sie können die Nutzung des Assistenten in Ihrem Dashboard einsehen, um das Nutzerverhalten und die Wirksamkeit der Dokumentation zu verstehen. Exportieren und analysieren Sie Abfragedaten, um Folgendes zu identifizieren:
  • Häufig gestellte Fragen, die möglicherweise umfassender abgedeckt werden sollten.
  • Inhaltslücken, bei denen Nutzerinnen und Nutzer Schwierigkeiten haben, Antworten zu finden.
  • Beliebte Themen, die von zusätzlichen Inhalten profitieren könnten.

​
Den Assistenten konfigurieren

Der Assistent ist für Pro- und Custom-Tarife standardmäßig aktiviert. Sie können ihn in Ihrem Dashboard verwalten – einschließlich Aktivieren/Deaktivieren, Konfiguration der Antwortverarbeitung und Festlegen eines Ausgabenlimits.

​
Assistent-Status

Schalten Sie den Assistent-Status um, um den Assistenten für Ihre Dokumentationsseite zu aktivieren oder zu deaktivieren.

​
Weiterleitung durch den Assistenten

Ermöglichen Sie dem Assistenten, unbeantwortete Fragen an Ihr Support-Team weiterzuleiten. Geben Sie eine E‑Mail‑Adresse an, die der Assistent Nutzern nennt, wenn sie Fragen stellen, die er nicht beantworten kann.

​
Suchseiten

Die Seitensuche ist in der Beta. Um sie für Ihre Dokumentationsseite zu aktivieren, kontaktieren Sie unser Vertriebsteam.
Konfigurieren Sie Seiten, die der Assistent für zusätzlichen Kontext bei der Beantwortung von Fragen durchsuchen kann.
  • Seiten müssen öffentlich zugänglich sein.
  • Seiten, die zum Laden JavaScript erfordern, werden nicht unterstützt.
Sie können bei der Konfiguration externer Seiten die folgende Filtersyntax verwenden:
  • Filterung auf Domainebene
    • example.com: Nur die Domain example.com durchsuchen
    • docs.example.com: Nur die Subdomain docs.example.com durchsuchen
    • *.example.com: Alle Subdomains von example.com durchsuchen
  • Filterung auf Pfadebene
    • docs.example.com/api: Alle Seiten unter dem Unterpfad /api durchsuchen
  • Mehrere Muster
    • Fügen Sie mehrere Einträge hinzu, um unterschiedliche Bereiche von Websites abzudecken

​
Ausgabenlimit

Legen Sie ein Ausgabenlimit fest, um zu steuern, was passiert, wenn Sie Ihr Nachrichtenkontingent erreichen. Standardmäßig beantwortet der Assistent weiterhin Benutzerfragen, nachdem Sie Ihr Kontingent erreicht haben, was zu Mehrkosten führt. Im Tab Billing auf der Seite Assistant Configurations können Sie ein Ausgabenlimit für Assistenten-Nachrichten über Ihr Kontingent hinaus festlegen. Wenn Sie Ihr Ausgabenlimit erreichen, wird der Assistent deaktiviert, bis Ihr Nachrichtenkontingent zurückgesetzt wird. Sie können auch Nutzungsbenachrichtigungen einrichten, um eine E-Mail zu erhalten, wenn Sie einen bestimmten Prozentsatz Ihres Ausgabenlimits erreichen.

​
Verwendung des Assistenten

Nutzer können auf drei Arten auf den Assistenten zugreifen:
  • Tastenkombinationen: ? oder Command + I (Ctrl + I unter Windows)
  • Assistent-Schaltfläche neben der Suchleiste Suchleiste und Assistent-Schaltfläche im hellen Modus.
  • URLs mit angehängtem ?assistant=open öffnen den Assistenten beim Laden der Seite. Zum Beispiel: https://mintlify.com/docs?assistant=open.
Alle drei Methoden öffnen ein Chat-Panel auf der rechten Seite Ihrer Doku. Nutzer können beliebige Fragen stellen, und der Assistent durchsucht Ihre Dokumentation nach Antworten. Wenn keine relevanten Informationen gefunden werden, antwortet der Assistent, dass er die Frage nicht beantworten kann.

​
Inhalte für KI leichter verarbeitbar machen

Strukturieren Sie Ihre Dokumentation so, dass der Assistent präzise und relevante Antworten liefern kann. Eine klare Struktur und umfassender Kontext helfen sowohl menschlichen Lesern als auch der KI.

Struktur und Organisation

  • Verwenden Sie semantisches Markup.
  • Schreiben Sie aussagekräftige Abschnittsüberschriften.
  • Bauen Sie eine logische Informationshierarchie auf.
  • Nutzen Sie konsistente Formatierung in der gesamten Dokumentation.
  • Ergänzen Sie umfassende Metadaten im Frontmatter der Seite.
  • Gliedern Sie lange Textblöcke in kürzere Absätze.

Kontext

  • Definieren Sie Fachbegriffe und Abkürzungen bei ihrer ersten Erwähnung.
  • Vermitteln Sie ausreichenden konzeptionellen Hintergrund zu Funktionen und Abläufen.
  • Fügen Sie Beispiele und Anwendungsfälle hinzu.
  • Verweisen Sie auf verwandte Themen.
  • Ergänzen Sie Verborgene Seiten mit zusätzlichem Kontext, den Nutzer nicht benötigen, auf den der Assistent jedoch zugreifen kann.

​
Abfragen exportieren und analysieren

Überprüfen und exportieren Sie Abfragen aus Ihrem Dashboard, um zu verstehen, wie Nutzer mit Ihrer Dokumentation interagieren, und um Verbesserungsmöglichkeiten zu identifizieren. So kann Ihnen die Analyse von Abfragen helfen, Ihre Dokumentation zu verbessern:
  • Ermitteln Sie Inhaltslücken, bei denen häufige Abfragen unzureichend beantwortet werden.
  • Entdecken Sie Nutzungsmuster und wiederkehrende Informationsbedürfnisse anhand von Themen und Mustern in den Abfragen.
  • Priorisieren Sie Seiten mit hohem Traffic für Verbesserungen bei Genauigkeit und Qualität.
Sie können Abfragen über Ihr Dashboard durchsuchen. Für tiefere Einblicke empfehlen wir jedoch, eine CSV-Datei Ihrer Abfragen, Antworten und Quellen zu exportieren und diese mit Ihrem bevorzugten KI-Tool zu analysieren.
  1. Navigieren Sie in Ihrem Dashboard zur Assistant-Seite.
  2. Wählen Sie Export to CSV.
  3. Analysieren Sie die exportierten Daten mit Ihrem bevorzugten Tool.

Beispielprompts für Analysen

  • Fassen Sie die häufigsten Themen der Abfragen zusammen.
  • Listen Sie alle Abfragen auf, bei denen keine Quellen zitiert wurden.
  • Finden Sie Muster in erfolglosen Interaktionen.