Merge pull request #17 from docmd-io/dev-0.9.0

Update docs for 0.9.0 + Added spanish translations

Author: mgks

docmd-assistant/de/api.md

@@ -0,0 +1,218 @@
+---
+title: "Programmierbare API"
+description: "Vollständige Klassen-, Methoden- und Typenreferenz für DocmdAssistantEngine."
+---
+
+Das Paket `docmd-assistant` exportiert die Hauptklasse `DocmdAssistantEngine`, Hilfsfunktionen und TypeScript-Typdefinitionen.
+
+```typescript
+import {
+  DocmdAssistantEngine,
+  createStandardTools,
+  DEFAULT_SYSTEM_PROMPT,
+  ENGINE_VERSION
+} from 'docmd-assistant';
+```
+
+## Klasse: DocmdAssistantEngine
+
+### Konstruktor
+
+```typescript
+new DocmdAssistantEngine(options?: AssistantOptions)
+```
+
+Initialisiert eine neue Engine-Instanz mit der angegebenen Konfiguration.
+
+```typescript
+const assistant = new DocmdAssistantEngine({
+  provider: 'openai',
+  model: 'gpt-4o-mini',
+  apiKey: process.env.OPENAI_API_KEY,
+  systemPrompt: 'Sie sind ein KI-Dokumentationsassistent.'
+});
+```
+
+## Nachrichteneigenschaften & Methoden
+
+### sendMessage(content, overrideOptions?)
+
+Hängt eine Benutzernachricht an den Verlauf an, führt die Konversationsrunde aus und gibt ein `ChatResponse`-Promise zurück.
+
+```typescript
+public async sendMessage(
+  content: string,
+  overrideOptions?: Partial<AssistantOptions>
+): Promise<ChatResponse>
+```
+
+**Parameter:**
+
+| Parameter | Typ | Beschreibung |
+| :-------- | :--- | :---------- |
+| `content` | `string` | Nachrichtentext des Benutzers |
+| `overrideOptions` | `Partial<AssistantOptions>` | Optionale Konfigurations-Overrides für eine Runde |
+
+**Rückgabewert:** `Promise<ChatResponse>`
+
+```typescript
+interface ChatResponse {
+  message: string;
+  role: 'assistant';
+  unconfigured?: boolean;
+  unconfiguredData?: any;
+  history: ChatMessage[];
+  usage?: {
+    promptTokens?: number;
+    completionTokens?: number;
+    totalTokens?: number;
+  };
+}
+```
+
+## Werkzeug-Verwaltungsmethoden
+
+### registerTool(tool)
+
+Registriert einen Werkzeug-Handler auf der Engine-Instanz.
+
+```typescript
+public registerTool(tool: AssistantTool): this
+```
+
+### unregisterTool(name)
+
+Enfernt ein Werkzeug nach Namen. Gibt `true` zurück, wenn das Werkzeug gefunden und gelöscht wurde.
+
+```typescript
+public unregisterTool(name: string): boolean
+```
+
+### getTools()
+
+Gibt ein Array aller registrierten Werkzeuge zurück.
+
+```typescript
+public getTools(): AssistantTool[]
+```
+
+### getTool(name)
+
+Gibt eine spezifische Werkzeugdefinition nach Namen zurück oder `undefined`, falls nicht registriert.
+
+```typescript
+public getTool(name: string): AssistantTool | undefined
+```
+
+### executeTool(name, args)
+
+Führt ein registriertes Werkzeug manuell mit Argumenten aus.
+
+```typescript
+public async executeTool(name: string, args: any): Promise<any>
+```
+
+## Konfigurations- & System-Prompt-Methoden
+
+### updateOptions(newOptions)
+
+Aktualisiert Engine-Optionen dynamisch.
+
+```typescript
+public updateOptions(newOptions: Partial<AssistantOptions>): this
+```
+
+### setSystemPrompt(prompt)
+
+Ersetzt den aktiven System-Prompt.
+
+```typescript
+public setSystemPrompt(prompt: string): this
+```
+
+### appendSystemPrompt(additionalPrompt)
+
+Hängt zusätzlichen Text an den bestehenden System-Prompt an.
+
+```typescript
+public appendSystemPrompt(additionalPrompt: string): this
+```
+
+### getSystemPrompt()
+
+Gibt den aktuell aktiven System-Prompt als String zurück.
+
+```typescript
+public getSystemPrompt(): string
+```
+
+## Verlaufs-Verwaltungsmethoden
+
+### getHistory()
+
+Gibt eine Kopie des aktuellen Konversationsverlaufs zurück.
+
+```typescript
+public getHistory(): ChatMessage[]
+```
+
+### setHistory(history)
+
+Ersetzt den aktuellen Konversationsverlauf.
+
+```typescript
+public setHistory(history: ChatMessage[]): this
+```
+
+### clearHistory()
+
+Löscht alle Nachrichten im Verlauf und löst das Event `'clear'` aus.
+
+```typescript
+public clearHistory(): this
+```
+
+### addMessage(message)
+
+Fügt ein Nachrichtenobjekt direkt zum Verlauf hinzu.
+
+```typescript
+public addMessage(message: ChatMessage): this
+```
+
+## Event-Subskriptionsmethoden
+
+### on(event, listener)
+
+Registriert einen Event-Listener für Engine-Events (`'message'`, `'tool_call'`, `'tool_result'`, `'error'`, `'clear'`).
+
+```typescript
+public on(event: AssistantEventType, listener: AssistantEventListener): this
+```
+
+### off(event, listener)
+
+Entfernt einen registrierten Event-Listener.
+
+```typescript
+public off(event: AssistantEventType, listener: AssistantEventListener): this
+```
+
+## Exportierte Typdefinitionen
+
+Alle TypeScript-Schnittstellen werden direkt aus `docmd-assistant` exportiert:
+
+```typescript
+import type {
+  AssistantOptions,
+  AssistantTool,
+  AssistantToolParameters,
+  AssistantToolParameterProperty,
+  ChatMessage,
+  ChatResponse,
+  SearchResultItem,
+  AssistantEventType,
+  AssistantEvent,
+  AssistantEventListener
+} from 'docmd-assistant';
+```

docmd-assistant/de/configuration.md

@@ -0,0 +1,104 @@
+---
+title: "Konfiguration"
+description: "Vollständige Referenz der Optionen für die Initialisierung und dynamische Runtime-Updates von docmd-assistant."
+---
+
+`docmd-assistant` akzeptiert bei der Initialisierung ein flexibles `AssistantOptions`-Konfigurationsobjekt. Alle Einstellungen können auch dynamisch zur Laufzeit aktualisiert werden.
+
+## Optionenschema-Referenz
+
+```typescript
+interface AssistantOptions {
+  provider?: string;
+  model?: string;
+  apiKey?: string;
+  baseURL?: string;
+  relayUrl?: string;
+  endpoint?: string;
+  projectId?: string;
+  systemPrompt?: string;
+  history?: ChatMessage[];
+  tools?: AssistantTool[];
+  temperature?: number;
+  maxTokens?: number;
+  reasoning?: boolean | 'none' | 'low' | 'medium' | 'high';
+  headers?: Record<string, string>;
+}
+```
+
+## Parameter-Details
+
+| Feld | Typ | Beschreibung | Standard |
+| :---- | :--- | :---------- | :------ |
+| `provider` | `string` | Ziel-KI-Anbieter (`'openai'`, `'anthropic'`, `'gemini'`, `'deepseek'`, `'groq'`, `'minimax'`, `'ollama'`) | Dynamisch |
+| `model` | `string` | Modell-Bezeichner (z. B. `'gpt-4o-mini'`, `'claude-3-5-haiku-20241022'`) | Dynamisch |
+| `apiKey` | `string` | Anbieter-API-Schlüssel für direkte Verbindung via `aiplug` | `undefined` |
+| `baseURL` | `string` | Benutzerdefinierte Basis-API-Gateway-URL | `undefined` |
+| `relayUrl` | `string` | Cloud-Relay-Endpunkt-URL für schlüsselloses Routing | `undefined` |
+| `endpoint` | `string` | Alias für `relayUrl` | `'https://api.docmd.io/v1/ai/chat'` |
+| `projectId` | `string` | Projekt-Bezeichner, der mit Relay-Anfragen gesendet wird | `undefined` |
+| `systemPrompt` | `string` | Anweisungen zur Identität und zum Verhalten des Assistenten | System-Standard |
+| `history` | `ChatMessage[]` | Vorbefüllter Konversationsverlauf | `[]` |
+| `tools` | `AssistantTool[]` | Initiales Array registrierter Werkzeuge | `[]` |
+| `temperature` | `number` | Sampling-Temperatur (0.0 bis 1.0) | Anbieter-Standard |
+| `maxTokens` | `number` | Maximale Token pro Antwort | Anbieter-Standard |
+| `reasoning` | `boolean \| string` | Umschalten des erweiterten Reasoning-Modus (`false`, `'low'`, `'medium'`, `'high'`) | `false` |
+| `headers` | `Record<string, string>` | Benutzerdefinierte HTTP-Header für Relay-Anfragen | `{}` |
+
+::: callout tip "Standard-System-Prompt"
+Wenn kein `systemPrompt` angegeben ist, wendet die Engine einen Standard-Prompt an, der Regeln für die Assistentenidentität, bevorzugte Werkzeugaufrufe und klickbare Zitationslinks durchsetzt.
+:::
+
+## Aktualisieren von Optionen zur Laufzeit
+
+Ändern Sie Konfigurationsoptionen dynamisch während einer aktiven Sitzung mit `updateOptions()`:
+
+```typescript
+assistant.updateOptions({
+  provider: 'anthropic',
+  model: 'claude-3-5-haiku-20241022',
+  temperature: 0.2
+});
+```
+
+## System-Prompt-Verwaltung
+
+`docmd-assistant` bietet dedizierte Methoden zum Aktualisieren oder Anhängen von Systemanweisungen:
+
+```typescript
+// System-Prompt vollständig ersetzen
+assistant.setSystemPrompt('Sie sind ein technischer Support-Spezialist für eine Entwicklerplattform.');
+
+// Zusätzlichen Kontext anhängen
+assistant.appendSystemPrompt('Antworten Sie immer auf Deutsch und stellen Sie Schritt-für-Schritt-Codebeispiele bereit.');
+
+// Aktuellen System-Prompt abrufen
+const currentPrompt = assistant.getSystemPrompt();
+```
+
+## Unterstützung für den Reasoning-Modus
+
+Für Modelle, die erweitertes Reasoning unterstützen (wie DeepSeek-R1 oder OpenAI o3-mini), stellen Sie die Option `reasoning` ein:
+
+```typescript
+const assistant = new DocmdAssistantEngine({
+  provider: 'deepseek',
+  model: 'deepseek-reasoner',
+  apiKey: process.env.DEEPSEEK_API_KEY,
+  reasoning: 'medium'
+});
+```
+
+## Benutzerdefinierte Relay-Header
+
+Übergeben Sie benutzerdefinierte Header beim Routing durch Unternehmens-API-Gateways:
+
+```typescript
+const assistant = new DocmdAssistantEngine({
+  relayUrl: 'https://internal-ai-gateway.company.com/v1/chat',
+  headers: {
+    'Authorization': 'Bearer my_enterprise_token',
+    'X-Custom-Tenant-ID': 'tenant_12345'
+  }
+});
+```