Документация и порталы для разработчиков

Ответы из вашей документации — с указанием строки, откуда они взяты.

Разработчики вставляют сообщения об ошибках, имена функций и полузабытые понятия. AACSearch обходит вашу документацию, разбивает её на разделы и отвечает со ссылками на источники — и никогда не предлагает несуществующий эндпоинт.

Запросы, на которых обычный поиск ошибается

ECONNRESET socket hang upсообщение об ошибкеhow to paginate list endpointинструкцияwebhook signature verifyпонятиеcreateClient optionsсимвол в кодеv2 vs v3 authверсии

Где поиск теряет клиентов сегодня

Результат — целая страница

Поиск возвращает страницу на 5000 слов, а ответ — в одном абзаце где-то в середине.

Путаница версий

Результаты по старой версии API ранжируются выше актуальной.

Выдуманные ответы

Универсальные чат-боты придумывают параметры и эндпоинты. Один неверный ответ обходится дороже десяти ненайденных.

Обращения по задокументированным вопросам

Поддержка отвечает на вопросы, которые уже описаны в документации, потому что поиск их не нашёл.

Как это решает AACSearch — по слоям

На каждой карточке указана возможность продукта. Пункты с пометкой «в разработке» спроектированы и запланированы, но ещё не в продукте.

Находит нужное с первых букв — с опечатками, синонимами, фильтрами и по смыслу.

Краулер DocSearch

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

Гибридный поиск

Точное совпадение по ключевым словам для символов кода плюс семантическое сопоставление для понятий.

Фасеты по версиям

Фильтрация и повышение в выдаче по версии продукта и разделу.

Расширяет корзину: похожие, вместе с этим, персональные.

Связанные страницы

«Похожие материалы» для страницы документации на основе близости эмбеддингов.

Отвечает на вопросы, на которые не ответит фильтр, — со ссылками на ваш каталог и документы.

Ответы со ссылками

Ответы строятся только из найденных разделов, каждое утверждение связано с источником; если документация не покрывает вопрос, ассистент отказывается отвечать.

Безопасность

Найденный текст проверяется на шаблоны prompt injection; ответы проверяются на опору на контекст.

Контроль качества ответов

Оценки ответов «нравится / не нравится» и эталонный набор вопросов с метриками nDCG и MRR позволяют отслеживать качество во времени.

Сам находит связи между товарами, запросами и темами — и ведёт посетителя к цели.

Карта понятий

Будет извлекать понятия и связи между ними из документации и отвечать на широкие вопросы («как устроена аутентификация от начала до конца?») по многим страницам.

Путь одного посетителя — от первого запроса до цели

Слева — что делает посетитель, справа — что делает AACSearch.

  1. 1

    Ошибка

    Вставляет сообщение об ошибке.

    Находит раздел по устранению неполадок, где она упоминается, а не всю страницу.

    Семантический и гибридный поиск
  2. 2

    Вопрос

    Спрашивает, как проверять подписи вебхуков.

    Отвечает фрагментом кода из документации и ссылкой на раздел.

    AI-ответы со ссылками
  3. 3

    Широкий вопрос

    Спрашивает, как устроена аутентификация от начала до конца.

    Обобщает материал нескольких страниц с помощью карты понятий.

    GraphRAG· в разработке

Первые две недели

Типичный запуск для этой отрасли. Обычно поиск работает уже в первый день, а остальное время уходит на измерения и настройку.

  1. День 1

    Сканировать документы по разделам.

  2. День 2

    Встроить поиск и ассистента на сайт документов.

  3. Неделя 1

    Создать золотой набор из вопросов поддержки; просмотреть неотвеченные.

  4. Неделя 2

    Сравнить объем тикетов с предыдущим месяцем.

Что измерять

По этим цифрам стоит оценивать внедрение. Сравнивайте их в A/B-тесте или в окне «до/после» на одном и том же трафике.

Снижение обращений (Ticket deflection)
Обращения в поддержку на одного активного пользователя; должны сокращаться по мере улучшения ответов.
Полезность ответов
Доля положительных оценок ответов ассистента.
nDCG на эталонных вопросах
Фиксированный набор вопросов, который оценивается после каждого изменения документации или ранжирования.

Подключается к

  • Обход sitemap / DocSearch
  • Загрузка Markdown / JSON
  • REST API
  • Виджет для встраивания

Используемые возможности

Скоро в продукте

Вопросы

Поиск для отрасли «Документация и SaaS» — запуск за неделю

Подключите фид или сайт, вставьте один скрипт и сравните результат на своём трафике.