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.
• Kostenloses docmd Cloud-Relay: Bereitstellung auf statischen Hosts (GitHub Pages, Cloudflare Pages, Netlify, Vercel) ohne Backend-Server-Infrastruktur.
• BYOK Server- & KMS-Sicherheit: API-Schlüssel werden im Ruhezustand via KMS in docmd Cloud verschlüsselt oder serverseitig aufgelöst (AI_API_KEY, OPENAI_API_KEY), 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 in docmd.config.json:

Option A: Kostenloses docmd Cloud-Relay (Statische Websites)

Für statische Websites (GitHub Pages, Cloudflare Pages, Netlify, Vercel, S3) nutzen Sie docmds kostenlosen Cloud-Relay-Dienst mit Ihrer projectId:

{
  "plugins": {
    "ai": {
      "assistant": true,
      "projectId": "docmd_aiv77jc8ms8qtpvd",
      "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"
      ]
    }
  }
}

Option B: Selbst gehosteter Server (BYOK-Umgebungsvariablen)

Wenn docmd als Node.js-Server oder Docker-Container betrieben wird:

{
  "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
      }
    }
  }
}

Optionenreferenz

Kostenlose docmd Cloud-Relay-Einrichtung

Wenn Sie Ihre Dokumentation als statische Dateien auf GitHub Pages, Cloudflare Pages, Netlify oder Vercel bereitstellen, ist kein separater Backend-Server erforderlich. docmd bietet einen kostenlosen Cloud-Relay-Dienst unter cloud.docmd.io:

1. Konto & Projekt erstellen: Melden Sie sich bei cloud.docmd.io an und erstellen Sie ein neues Projekt.
2. Zugehörige Domain festlegen: Tragen Sie unter Projekteinstellungen (Project Configuration) Ihre Dokumentations-Domain ein (z. B. docs.mycompany.com). Nur Anfragen von dieser Domain werden zur Nutzung des Relays autorisiert.
3. Localhost-Tests aktivieren (Entwicklung): Aktivieren Sie für lokale Tests die Option Localhost-Tests aktivieren (127.0.0.1 / localhost). Deaktivieren Sie diese Option vor dem Live-Gang.
4. Modell & BYOK-Schlüssel konfigurieren: Wählen Sie unter Assistenten-Modell & BYOK-Schlüssel-Einrichtung Ihren KI-Anbieter (OpenAI, Anthropic, Gemini, Groq, DeepSeek etc.), geben Sie Modellname und API-Schlüssel ein, klicken Sie auf Verbindung testen (Test Connection) und anschließend auf Schlüssel & Konfiguration speichern. Alle Schlüssel werden mittels Hardware-Sicherheitsmodul (KMS) im Ruhezustand verschlüsselt.
5. Projekt-ID zur Konfiguration hinzufügen: Kopieren Sie im Tab Integration das projectId-Snippet in Ihre docmd.config.json:

   {
     "plugins": {
       "ai": {
         "assistant": true,
         "projectId": "docmd_aiv77jc8ms8qtpvd"
       }
     }
   }
   

Serverseitige Sicherheit (Selbst gehostetes BYOK)

Beim Betrieb als Node.js-Server setzen Sie die Umgebungsschlüssel des Anbieters vor dem Serverstart:

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) oder injiziert den Cloud-Relay-Client mit Ihrer projectId.
2. Retrieval-Augmented Generation (RAG): Wenn ein Leser eine Frage sendet:
   • Der Client fragt den von @docmd/plugin-search kompilierten Suchindex oder MCP-Tools ab.
   • Passende Dokumentenüberschriften und Textabschnitte werden basierend auf Vektor-/Schlüsselwortdistanz ausgewählt.
   • Relevante Abschnitte und Tool-Ergebnisse werden an das Relay oder den Server-Endpunkt übertragen.
3. Provider-Verarbeitung & Zitate: Die Anfrage wird sicher an den festgelegten Modellanbieter weitergeleitet. Antworten werden in Echtzeit gestreamt, inklusive Links auf Quellanker.