Das @docmd/plugin-ai-Plugin fügt Ihrer Dokumentationsseite ein interaktives KI-Assistenten-Overlay hinzu. Es nutzt die vorkompilierten Indizes von @docmd/plugin-search, um Retrieval-Augmented Generation (RAG) durchzuführen und gezielte Dokumentationsabschnitte abzufragen, um kontextbezogene Antworten mit direkten Quelllinks zu liefern.

Hauptfunktionen

• Schwebender Trigger & Glassmorphism-Drawer: Sauberer Pill-Trigger (⌘K-Tastenkürzel), der sich in ein themenbewusstes Chat-Panel ausklappt.
• Suchbasiertes RAG: Fragt vorgebaute search-index.json-Daten ab, um LLM-Antworten direkt in der Dokumentation Ihrer Website zu verankern.
• BYOK-Serversicherheit: API-Schlüssel werden ausschließlich in Serverumgebungen (AI_API_KEY, OPENAI_API_KEY) aufgelöst, was eine Null-Credential-Offenlegung in Client-Web-Bundles garantiert.
• Multi-Provider-Integration: Angetrieben von aiplug mit nativer Unterstützung für OpenAI, Anthropic, Gemini, DeepSeek, Groq und lokale Ollama-Instanzen.
• Themen-Neutralität: Passt sich an helle und dunkle Themenmodi über alle integrierten und benutzerdefinierten Vorlagen hinweg an.

Konfigurationsoptionen

Konfigurieren Sie Assistentenoptionen und Provider-Anmeldeinformationen in docmd.config.json:

{
  "plugins": {
    "ai": {
      "assistant": true,
      "provider": "openai",
      "model": "gpt-4o-mini",
      "position": "bottom-center",
      "greeting": "Wie kann ich heute bei dieser Dokumentation helfen?",
      "placeholder": "Frage an die KI stellen...",
      "suggestions": [
        "Wie starte ich?",
        "Zeige Konfigurationsoptionen",
        "Erkläre Schlüsselkonzepte"
      ],
      "contextLimit": 5,
      "rateLimit": {
        "maxRequests": 10,
        "windowMs": 60000
      }
    }
  }
}

Optioneneferenz

Serverseitige Sicherheit (Bring-Your-Own-Key)

Setzen Sie die Umgebungsschlüssel des Anbieters vor dem Start Ihres Dokumentationsservers:

export OPENAI_API_KEY="sk-..."
# oder
export ANTHROPIC_API_KEY="sk-ant-..."
# oder generischer Fallback
export AI_API_KEY="ihr-api-schlüssel"

Architektur-Ausführungsfluss

1. Registrierung von Aktionen zur Build-Zeit: Während der Website-Kompilierung registriert @docmd/plugin-ai serverseitige RPC-Aktionshandler (ai:chat) und injiziert ein leichtes Client-Trigger-Skript.
2. Retrieval-Augmented Generation (RAG): Wenn ein Leser eine Frage sendet:
   • Der RPC-Endpunkt fragt den von @docmd/plugin-search kompilierten Suchindex ab.
   • Passende Dokumentenüberschriften und Textabschnitte werden basierend auf Vektor-/Schlüsselwortdistanz ausgewählt.
   • Relevante Ausschnitte werden zusammen mit dem Gesprächsverlauf des Benutzers in einen strukturierten System-Prompt kompiliert.
3. Provider-Verarbeitung & Zitate: Die Anfrage wird über aiplug an den angegebenen Anbieter weitergeleitet. Ausgabeantworten werden mit Markdown-Links zurückgegeben, die auf referenzierte Dokumentationsanker verweisen.