立足于您文档的 AI 助手。
支持任意 LLM 提供商。您的 API Key 绝不出服务器。
读取您的文档,基于上下文回答问题。支持 100+ 模型、任何网站,并确保您的 API 密钥安全无虑。
配置 DocmdAssistantEngine 直连本地 Ollama 实例。向量检索与模型推理全部在本地硬件完成,无需云端 API 密钥与数据上传。
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 Key 安全保留在服务端
您的 AI 提供商凭据安全地留在服务端。浏览器客户端绝不会持有、传输或暴露原始 API Key。
立足于您内容的准确回答
在回答前,引擎通过 docmd-search 索引提取相关文档片段,确保回答准确无误且符合上下文。
通过本地模型实现 100% 离线运行
无缝连接本地 Ollama(llama3、mistral、qwen),实现完全物理隔离的零云端运行。
支持 100+ AI 提供商与定制化端点
由 AIPlug 通用传输运行时强力驱动。直连前沿云端模型、通过 Cloud Relay 安全路由、在本地硬件上完全离线运行,或直接对接企业专属定制 API,无任何供应商锁定。
@memoryblock/aiplug)编排模型连接。AIPlug 是一款轻量运行时,在统一标准协议下集成了 100 多个提供商和定制 API 端点。| 提供商 | 支持的模型 | 连接模式 | 安全架构 |
|---|---|---|---|
| OpenAI | gpt-4o, gpt-4o-mini, o1, o3-mini | 直连 / 中继 | 硬件 KMS 安全保护 |
| Anthropic | claude-3-7-sonnet, haiku | 直连 / 中继 | 硬件 KMS 安全保护 |
| Google Gemini | gemini-2.0-flash, pro | 直连 / 中继 | 硬件 KMS 安全保护 |
| DeepSeek & Groq | deepseek-chat, deepseek-r1, llama-3.3 | 直连 / 中继 | 硬件 KMS 安全保护 |
| Ollama (Local) | llama3.3, mistral, qwen2.5, phi-4 | 纯离线直连 | 100% 本地运行 / 无云端调用 |
| 定制与企业级 API | vLLM、LocalAI、内部 OpenAI 兼容代理、私有模型 | 自定义 Base URL | 零遥测 / 本地私有化 |
| 通过 AIPlug 支持 100+ 提供商 | Mistral、Cohere、Bedrock、Together AI、Azure OpenAI、OpenRouter | AIPlug 统一传输 | 统一 BYOK 与硬件 KMS 安全 |
面向静态文档的免费 docmd Cloud Relay
正在部署到 GitHub Pages、Cloudflare Pages、Netlify 或 Vercel?无需自行搭建服务器即可启用文档 AI 助手。
绑定您的域名
使用 GitHub 登录 cloud.docmd.io 并关联您的文档域名。
保存加密的 BYOK 密钥
存储您的 OpenAI、Anthropic 或 Gemini API 密钥,在存储时通过硬件 KMS 信封加密保护。
在配置中填入 Project ID
将 projectId 添加到 docmd.config.json 中。客户端通过域名验证会话进行安全通信。
数行代码完成集成
创建引擎实例、连接搜索索引,即可开始回答问题。支持流式传输、自定义工具和完整对话历史。
docmd.config.json
JSON零配置框架插件。在项目配置中即可直接启用悬浮 AI 助手并链接 Cloud Relay。
assistant-engine.ts
TypeScript面向 Node.js 与现代运行时的无界面引擎。直接初始化 Anthropic、OpenAI 或 Ollama 并实时流式传输 Token 增量。
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 Key 安全吗?
它能完全离线运行吗?
http://localhost:11434),整个工作流(向量检索与模型应答)完全在您自己的硬件上 100% 离线运行,无需任何外网调用。docmd 会保留用户提问或文档数据吗?
在 GitHub Sponsors 上支持 docmd
docmd 100% 开源且永久免费。赞助将直接用于支持项目开发与免费公共中继基础设施。