AI-ассистент на базе вашей документации.
Любые провайдеры LLM. Ключи никогда не покидают ваш сервер.
Читает вашу документацию и отвечает на вопросы в контексте. Работает со 100+ моделями, любым сайтом, и надёжно защищает ваши API-ключи.
workspaces в docmd.config.json со свойствами prefix и src.Как это работает
Headless-движок и плагин для фреймворка, разработанные для независимого или совместного использования.
Headless: используйте где угодно
docmd-assistant — это независимая библиотека без жесткого UI. Интегрируйте в React, Vue, Svelte, Node.js или любое JavaScript-приложение.
Ключи API остаются на сервере
Ваши ключи AI-провайдеров надежно хранятся на сервере. Клиент в браузере никогда не получает и не передает исходные ключи API.
Ответы на основе вашего контента
Перед ответом движок извлекает релевантные фрагменты из документации с помощью docmd-search, гарантируя точные ответы.
Работает с любыми AI-провайдерами
Подключайтесь напрямую к облакам или через защищенное реле. Работает 100% офлайн с локальными моделями.
| Провайдер | Поддерживаемые модели | Режим подключения | Архитектура безопасности |
|---|---|---|---|
| OpenAI | gpt-4o, gpt-4o-mini | Direct / Relay | Серверное шифрование конвертов KMS |
| Anthropic | claude-3-5-sonnet, haiku | Direct / Relay | Серверное шифрование конвертов KMS |
| Google Gemini | gemini-1.5-flash, pro | Direct / Relay | Серверное шифрование конвертов KMS |
| DeepSeek & Groq | deepseek-chat, llama-3.3 | Direct / Relay | Серверное шифрование конвертов KMS |
| Ollama (Local) | llama3, mistral, qwen | Direct Offline | 100% Локально / Без Облака |
Интеграция в несколько строк кода
Создайте экземпляр движка, подключите поисковый индекс и начинайте отвечать на вопросы. Поддерживает стриминг и кастомные инструменты.
import { DocmdAssistantEngine } from 'docmd-assistant'; import * as Search from '@docmd/plugin-search/client'; // 1. Initialise engine instance with provider configuration const engine = new DocmdAssistantEngine({ provider: 'openai', model: 'gpt-4o-mini', systemPrompt: 'You are a helpful software documentation assistant.', ragCallback: async (query) => { const matches = await Search.search(query, 5); return matches.map(m => m.chunk.text).join('\\n\\n'); } }); // 2. Register custom client-side execution tool engine.registerTool({ name: 'fetch_user_workspace', description: 'Retrieve active workspace configuration', parameters: { type: 'object', properties: { workspaceId: { type: 'string' } } }, handler: async ({ workspaceId }) => ({ activeTheme: 'summer', mode: 'spa' }) }); // 3. Listen to real-time stream events and execute query turn engine.on('token', (chunk) => process.stdout.write(chunk)); await engine.sendMessage('How do I set up custom navigation in docmd?');
Часто задаваемые вопросы
Вопросы о docmd-assistant и AI-плагине.
Откуда он знает правильный ответ?
Безопасны ли мои ключи API?
Может ли работать полностью офлайн?
Добавьте AI-ассистента в ваши docs
Open source, работает с любым сайтом документации. Настройка за пару минут.