v0.1.1 Уже доступно

Локальный семантический поиск.
Без ключей API. Полностью приватный.

Включите мгновенный семантический поиск на вашем сайте документации с крошечной средой выполнения в браузере <3KB. Без сетевых зависимостей, без затрат.

Начать
Локальные модели 100% Приватный Чисто математический клиент Бесплатно
Песочница docmd-search
Аутентификация пользователей и сессии
/getting-started/security
98% совпадение
Настройте обработку входа пользователей, защищенные cookie и генерацию токенов.
Настройка защищенных маршрутов
/configuration/routing
89% совпадение
Определяйте приватные директории и перенаправления для неавторизованных сессий при попытке доступа к страницам входа.

Приватный семантический поиск

Внедрите современный векторный поиск в вашу статическую документацию без сторонних сервисов.

Минимальный клиент

Среда выполнения в браузере занимает менее 3 КБ в сжатом виде. Она не загружает веса моделей и не запускает нейронные сети — выполняя чистые арифметические операции для мгновенной гибридной оценки релевантности.

ONNX Wasm Runtime — 100% Offline

Автономная индексация

Эмбеддинги создаются локально на этапе компиляции с использованием ONNX Runtime. Клиент использует гибридный BM25-скоринг по ключевым словам и косинусное сходство.

Cosine Similarity Matching

Гибридное переранжирование

Сочетает быстрый BM25-поиск по ключевым словам с векторным сходством для максимальной релевантности и скорости.

BM25 + Cosine Re-ranker

Поддерживаемые модели эмбеддингов

Выберите идеальную модель эмбеддинга для размера вашей документации и используемых языков.

Модель Размерность Размер Языки Лучше всего подходит
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. Модель по умолчанию поддерживает только английский язык и будет давать низкую релевантность поиска для других языков.

Pure-Client API: Создавайте свои интерфейсы

Сверхлегкая клиентская среда выполнения (<5KB в минифицированном виде), которая полностью выполняется в браузере, используя гибридную оценку BM25 и косинусное сходство векторов.

import * as Search from '@docmd/plugin-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);
});

Часто задаваемые вопросы о поиске

Все, что вы хотели знать об автономном семантическом поиске docmd.

Работает ли поиск docmd полностью на стороне клиента?
Да. Среда выполнения поиска выполняет все вычисления векторного сходства и индексацию по ключевым словам непосредственно в браузере пользователя. Для этого не требуется облачная инфраструктура или поисковые API.

Читать документацию docmd-search →
Загружаются ли веса модели ONNX при каждом посещении?
Нет. Веса моделей загружаются только во время компиляции/сборки с использованием Node.js для генерации статических векторных индексов поиска. Клиентская среда выполнения загружает только предварительно созданные индексы, которые представляют собой сжатые JSON-фрагменты.

Узнайте, как работает автономный поиск →
Могу ли я использовать поисковый плагин на нескольких языках?
Да. Если ваша документация является многоязычной, вам следует выбрать многоязычную модель внедрения, такую как paraphrase-multilingual-MiniLM-L12-v2, которая поддерживает более 50 языков.

Подробнее о многоязычных поисковых моделях →
Что такое showConfidence и как это работает?
Флаг showConfidence, когда он включен, отображает точный процентный показатель соответствия (бейдж сходства) рядом с каждым семантическим результатом, помогая пользователям визуально понимать релевантность поиска.

Читать о настройках браузерного клиента →

Готовы создавать лучшую документацию?

Присоединяйтесь к разработчикам, создающим быструю и красивую документацию с docmd.