v0.1.0-alpha.0现已推出

本地语义搜索。
无需 API 密钥。100% 隐私安全。

在浏览器中启用极速语义搜索,仅需小于 3KB 的客户端运行环境。零网络依赖,零额外成本。

开始使用
本地嵌入生成 100% 隐私安全 纯算术客户端 零额外成本
docmd-search sandbox
User Authentication & Sessions
/getting-started/security
98% match
Configure how your application handles user login, secure cookies, token generation, and stateless session verification.
Configuring Custom Secure Routes
/configuration/routing
89% match
Define private directories and redirect configurations for unauthenticated guest sessions trying to access signin paths.

私有化语义搜索

无需任何第三方服务,将现代向量搜索直接带入您的静态文档中。

极简客户端

浏览器运行环境小于 3KB (gzipped)。无需下载任何向量模型权重,也不运行神经网络,而是执行极速纯算术混合评分。

离线向量构建

在构建阶段通过 ONNX Runtime 在本地计算并量化向量嵌入。客户端完美融合 BM25 关键词匹配与余弦相似度重排。

混合检索与重排

完美融合超高速 BM25 关键词匹配与精准的向量相似度,实现无可比拟的检索精度与响应速度。

受支持的向量嵌入模型

根据您的文档规模和目标语言,灵活选择最适合您的向量嵌入模型。

模型名称 维度 体积 适用语言 最佳适用场景
MiniLM L6 v2 ★ 384 ~23 MB 仅限英语 极速构建,通用英文文档
Multilingual MiniLM L12 384 ~118 MB 50+ 种语言 多语言 i18n 静态文档
Multilingual E5 Small 384 ~118 MB 100+ 种语言 极佳的超多语种覆盖
Multilingual MPNet Base 768 ~270 MB 50+ 种语言 最高的跨语言检索品质

💡 多语言文档特别提示: 如果您的文档网站支持多种语言(如英语、中文、德语、西班牙语等),请务必使用 docmd-search --settings 切换到多语言模型。默认模型仅支持英语,用于其他语言时搜索效果会大幅下降。 If your documentation website contains multiple languages (such as English, Chinese, German, Spanish, etc.), select a multilingual model using docmd-search --settings. The default model is English-only and will produce poor search relevance for other languages.

纯客户端 API:构建自定义搜索 UI

极轻量级(压缩后 <5KB)的纯客户端运行时,完全在浏览器内执行,使用混合 BM25 关键词词频与向量余弦相似度重排进行本地评分。

import * as Search from 'docmd-search/client';
// 1. Initialise and load index folder.
// Batch 0 is loaded instantly for sub-millisecond search startup,
// while remaining chunk batches load progressively in background.
await Search.load('/.docmd-search', (loaded, total) => {
  console.log(`Loaded batch ${loaded}/${total}`);
});
// 2. Query search using hybrid vector + keyword matching.
const results = Search.search('authentication secure routes', 10);
results.forEach(({ score, chunk }) => {
  console.log(`[${(score * 100).toFixed(0)}%] ${chunk.file}#${chunk.heading || ''}`);
  console.log(chunk.text);
});

极简命令行一键集成

只需数秒,即可在本地构建索引并可视化预览搜索匹配精度.

终端控制台
$ npx docmd-search --build
 Loaded local vector model
 Generated static index: .docmd-search/index.json

搜索常见问题解答

关于 docmd 离线语义搜索您需要了解的一切。

docmd 搜索是完全在客户端运行的吗?
是的。搜索运行时直接在用户的浏览器中执行所有向量相似度计算和关键词索引。它不需要任何云端基础设施或搜索 API。

阅读 docmd-search 文档 →
每次访问都会下载 ONNX 模型权重吗?
不会。模型权重仅在编译/构建时通过 Node.js 加载,以生成静态搜索向量索引。客户端运行时仅下载预构建的索引,这些索引是压缩的 JSON 分块。

了解离线搜索如何工作 →
我可以在多语言文档中使用搜索插件吗?
可以。如果您的文档是多语言的,您应该选择支持 50 多种语言的多语言嵌入模型(例如 paraphrase-multilingual-MiniLM-L12-v2)。

了解多语言搜索模型 → which supports over 50 languages.

Learn about multi-language search models →
什么是 showConfidence,它是如何工作的?
启用 showConfidence 标志后,每个语义检索结果旁都会显示准确的相似度匹配百分比徽章,帮助用户直观理解搜索相关性。

阅读有关浏览器客户端设置的内容 → flag, when enabled, displays the exact similarity matching percentage badge next to each semantic result, helping users visually understand search relevance.

Read about browser-client settings →

准备好写更好的文档了吗?

加入使用 docmd 构建快速、精美文档的开发者行列。