AI-ассистент на базе вашей документации.
Любые провайдеры LLM. Ключи никогда не покидают ваш сервер.
Читает вашу документацию и отвечает на вопросы в контексте. Работает со 100+ моделями, любым сайтом, и надёжно защищает ваши API-ключи.
Настройте DocmdAssistantEngine для прямого подключения к локальному инстансу Ollama. Векторные эмбеддинги и генерация работают локально без облачных ключей.
import { DocmdAssistantEngine } from 'docmd-assistant';
const engine = new DocmdAssistantEngine({
provider: 'ollama',
model: 'llama3.2',
baseUrl: 'http://localhost:11434'
});
Как это работает
Headless-движок и плагин для фреймворка, разработанные для независимого или совместного использования.
Headless: используйте где угодно
docmd-assistant – это независимая библиотека без жесткого UI. Интегрируйте в React, Vue, Svelte, Node.js или любое JavaScript-приложение.
Ключи API остаются на сервере
Ваши ключи AI-провайдеров надежно хранятся на сервере. Клиент в браузере никогда не получает и не передает исходные ключи API.
Ответы на основе вашего контента
Перед ответом движок извлекает релевантные фрагменты из документации с помощью docmd-search, гарантируя точные ответы.
100% оффлайн с локальными моделями
Легко подключайтесь к локальной Ollama (llama3, mistral, qwen) для полностью изолированной работы без облака.
Работает со 100+ провайдерами ИИ и кастомными эндпоинтами
На базе универсального транспортного уровня AIPlug. Подключайтесь напрямую к облачным моделям, маршрутизируйте через Cloud Relay, запускайте полностью оффлайн на локальном оборудовании или обращайтесь к собственным корпоративным API без привязки к поставщику.
@memoryblock/aiplug) — легковесную среду, объединяющую более 100 провайдеров и кастомных API под единым стандартным протоколом.| Провайдер | Поддерживаемые модели | Режим подключения | Архитектура безопасности |
|---|---|---|---|
| OpenAI | gpt-4o, gpt-4o-mini, o1, o3-mini | Прямое / Relay | Аппаратная безопасность KMS |
| Anthropic | claude-3-7-sonnet, haiku | Прямое / Relay | Аппаратная безопасность KMS |
| Google Gemini | gemini-2.0-flash, pro | Прямое / Relay | Аппаратная безопасность KMS |
| DeepSeek & Groq | deepseek-chat, deepseek-r1, llama-3.3 | Прямое / Relay | Аппаратная безопасность KMS |
| Ollama (Local) | llama3.3, mistral, qwen2.5, phi-4 | Прямое Оффлайн | 100% локально / Без облака |
| Кастомные и корпоративные API | vLLM, LocalAI, внутренние OpenAI-совместимые прокси, собственные модели | Пользовательский Base URL | Без телеметрии / На своих серверах |
| 100+ через среду AIPlug | Mistral, Cohere, Bedrock, Together AI, Azure OpenAI, OpenRouter | Единый транспорт AIPlug | Единый BYOK и аппаратный KMS |
Бесплатный docmd Cloud Relay для статической документации
Развертываете на GitHub Pages, Cloudflare Pages, Netlify или Vercel? Включите ИИ-ассистента без настройки серверов.
Подключите свой домен
Войдите на cloud.docmd.io через GitHub и привяжите доменное имя вашей документации.
Сохраните зашифрованный ключ BYOK
Сохраните API-ключ OpenAI, Anthropic или Gemini. Надежно зашифрован аппаратными конвертами KMS.
Вставьте Project ID в конфигурацию
Добавьте projectId в docmd.config.json. Клиент безопасно подключается через сессии с проверкой домена.
Интеграция в несколько строк кода
Создайте экземпляр движка, подключите поисковый индекс и начинайте отвечать на вопросы. Поддерживает стриминг и кастомные инструменты.
docmd.config.json
JSONПлагин без настройки. Включите плавающего ИИ-ассистента и подключите Cloud Relay прямо в конфигурации проекта.
assistant-engine.ts
TypeScriptHeadless-движок для Node.js и современных сред. Инициализируйте Anthropic, OpenAI или Ollama и транслируйте дельты токенов напрямую.
register-tools.ts
TypeScriptРасширяемое выполнение инструментов. Регистрируйте пользовательские функции, навигацию по документации или поиск на сервере.
// 1. Drop into docmd.config.json — zero server maintenance { "plugins": { "search": { "indexBody": true }, "ai": { "assistant": true, "projectId": "docmd_aiv77jc8ms8qtpvd", "position": "bottom-center", "greeting": "How can I help with these docs today?" } } }
import { DocmdAssistantEngine } from 'docmd-assistant'; // Initialise headless engine with any provider or custom gateway const assistant = new DocmdAssistantEngine({ provider: 'anthropic', model: 'claude-3-5-haiku-20241022', apiKey: process.env.ANTHROPIC_API_KEY, systemPrompt: 'You are an expert technical guide for our documentation.' }); // Subscribe to streaming response deltas assistant.on('chunk', (event) => process.stdout.write(event.data)); const response = await assistant.sendMessage('How do I configure custom plugins?'); console.log(response.message);
import { DocmdAssistantEngine, createStandardTools } from 'docmd-assistant'; // Connect via Cloud Relay with zero API key exposure on clients const assistant = new DocmdAssistantEngine({ projectId: 'docmd_aiv77jc8ms8qtpvd', endpoint: 'https://api.docmd.io/v1/ai/chat' }); // Register built-in search & navigation tools for (const tool of createStandardTools()) { assistant.registerTool(tool); } // Register custom domain tool (executed securely on server) assistant.registerTool({ name: 'lookup_account', description: 'Retrieve user account plan details', execute: async ({ email }) => ({ plan: 'enterprise', active: true }) });
Часто задаваемые вопросы
Вопросы о docmd-assistant и AI-плагине.
Откуда он знает правильный ответ?
Безопасны ли мои ключи API?
Может ли работать полностью офлайн?
http://localhost:11434) весь пайплайн (векторный поиск и генерация ответов) выполняется на 100% оффлайн на вашем оборудовании без сетевых вызовов в облако.Сохраняет ли docmd вопросы пользователей или данные документации?
Добавьте AI-ассистента в ваши docs
Open source, работает с любым сайтом документации. Настройка за пару минут.
Поддержите docmd на GitHub Sponsors
docmd полностью бесплатен и открыт. Спонсорство напрямую поддерживает разработку и бесплатную инфраструктуру реле.