Гайд · TNWS AI
Как отделить провал RAG-поиска от отсутствия документа в индексе
Сверяем эталонные document_id с инвентарём индекса до вычисления retrieval-метрик и показываем разные причины пропуска.
Практическая задача
Не обвинить ранжирование в провале, когда нужного документа вообще нет в поисковом индексе. Если эталонный документ отсутствует в текущем снимке индекса, поиск не может его вернуть. Поэтому перед оценкой Recall@K сопоставьте gold ID с набором индексированных ID и выделите случаи missing. Учебная функция не удаляет неудобные вопросы из отчёта: она показывает отдельный статус, чтобы команда решила проблему индексации. Даже наличие ID в инвентаре не гарантирует, что документ доступен конкретному пользователю или актуален. Этот сценарий применим, когда у команды есть контроль над входом или выходом AI-приложения и требуется конкретный сигнал о нарушении правила, а не общее впечатление от нескольких ответов. Все входы ниже вымышлены; числовые результаты относятся только к этим примерам.
Документация методов Python и синтаксиса workflow сверена 20.09.2026. Если вы используете другое окружение, проверьте совместимость до копирования команд. Статья не утверждает, что показанный код измеряет качество конкретной модели или заменяет ручную проверку.
Подготовка и проверяемый контракт
Перед запуском запишите, какие данные считаются входом, что является ожидаемым результатом, что именно означает отказ и кому предстоит разбирать расхождение. Для такой проверки храните тестовый вход, ожидаемый результат и фактический исход раздельно: если они смешаны, тест может подтверждать сам себя. Используйте стабильные синтетические ID, чтобы видеть ошибку в журнале, не раскрывая содержимое клиентских обращений.
Сначала прогоните тест на маленьком входе, где правильное поведение известно вручную. Затем внесите одну контролируемую ошибку и убедитесь, что код её замечает. После этого верните корректный набор и только тогда расширяйте проверку до реальных данных. Не переносите демонстрационные численные значения или пороги в производство без отдельного обоснования: они выбраны для наглядности, а не рассчитаны по вашей аудитории.
Вход и ожидаемый результат
Для Q1 эталон A содержится в индексе; для Q2 эталон Z отсутствует, хотя выдача содержит B. Q1 помечен RETRIEVED; Q2 — MISSING_FROM_INDEX и содержит ID Z. Перед тем как применять правило к закрытым данным, обсудите пограничные случаи, которые могут поменять интерпретацию входа. Запись в документации о границах теста не менее важна, чем зелёный check.
Пошаговые действия
- Создайте
scripts/check.pyв корне репозитория и вставьте код из блока ниже. Он использует названия функций стандартной библиотеки, указанные в официальных ссылках в конце статьи. - Выполните
python scripts/check.pyлокально. Не продолжайте, если уже демонстрационная фикстура даёт иной результат: сначала проверьте копирование кода и кодировку файла. - Снимите инвентарь document_id с той же версии индекса, которая обслуживала тест. Запустите диагностику и проверьте, что Q2 не сводится к ошибке ранжирования. В рабочем наборе различайте отсутствие документа в исходном корпусе, неудачную индексацию и фильтрацию по правам: в примере проверяется лишь инвентарь. После восстановления источника пересоберите индекс и повторите запрос на том же эталоне. Не исключайте отсутствующие ID из общей статистики молча — публикуйте их количество отдельно.
- Создайте
.github/workflows/ai-corpus-check.ymlиз YAML-шаблона. Событиеpull_requestполезно для проверки данных до слияния; чтение репозитория ограниченоpermissions: contents: read. Скрипт не должен получать ключ внешней модели или реальные секреты. - В разделе Actions откройте job
check, сопоставьте его код завершения с локальным прогоном и зафиксируйте ссылку на проверенный коммит в PR. Не принимайте зелёный результат на старой ревизии за проверку последнего изменения.
# scripts/check.py
index_ids={"A","B","C"}
queries={"Q1":{"gold":{"A"},"ranked":["B","A"]},
"Q2":{"gold":{"Z"},"ranked":["B","C"]}}
def diagnose(case):
gold=set(case["gold"])
if not gold: return "NO_GOLD"
missing=gold-index_ids
if missing: return "MISSING_FROM_INDEX",sorted(missing)
return ("RETRIEVED" if gold.intersection(case["ranked"])
else "NOT_RETRIEVED"),[]
assert diagnose(queries["Q1"])[0]=="RETRIEVED"
assert diagnose(queries["Q2"])==("MISSING_FROM_INDEX",["Z"])
print({q:diagnose(case) for q,case in queries.items()})
name: AI corpus checks
on:
pull_request:
permissions:
contents: read
jobs:
check:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v7
- uses: actions/setup-python@v7
with:
python-version: '3.13'
- run: python scripts/check.py
Ошибки интерпретации и границы
Сравнение двух наборов ID не проверяет содержимое, актуальность и права доступа. Если снимки индекса и эталона сделаны в разные моменты, вывод может быть ложным. Если вы расширяете набор случаев, добавляйте не только новые примеры, но и отрицательные случаи, на которых тест обязан упасть. Проверяйте, что изменение expected прошло ревью отдельно от изменения кода: иначе можно незаметно изменить правило под текущий ответ системы. Избегайте вывода полного приватного набора в CI и не сохраняйте в артефактах ответ закрытой модели без решения о доступе и хранении.
Ошибка выполнения самого Python, нераспознанный формат входа и обнаруженный бизнес-дефект — разные ситуации. В сообщении теста указывайте тип проблемы и безопасный ID. Если тест требует внешний сервис, вынесите его из PR с недоверенным кодом и явно ограничьте доступ к токенам; этот пример намеренно работает локально. Перед публикацией каких-либо результатов опишите методику, область применения и происхождение примеров, иначе читатель воспримет демонстрационную арифметику как характеристику продукта.
Практический разбор именно этого контроля
Не обвинить ранжирование в провале, когда нужного документа вообще нет в поисковом индексе. Для самостоятельной проверки сначала выпишите три наблюдаемых состояния: допустимый вход, намеренно недопустимый вход и видимый сигнал отказа. В данной фикстуре это выглядит так: Для Q1 эталон A содержится в индексе; для Q2 эталон Z отсутствует, хотя выдача содержит B. При успешном тесте ожидается: Q1 помечен RETRIEVED; Q2 — MISSING_FROM_INDEX и содержит ID Z. Не превращайте это в числовой KPI: здесь проверяется контракт на конкретных примерах, а не поведение модели на пользовательском трафике.
Сравнение двух наборов ID не проверяет содержимое, актуальность и права доступа. Если снимки индекса и эталона сделаны в разные моменты, вывод может быть ложным. Подключая проверку к продукту, расположите её до той операции, ради которой она написана: парсинга, сохранения, отображения или экспорта. Для каждого нового формата добавляйте отдельный негативный пример и письменное решение, почему он отклоняется. Отдельно просмотрите обработку ошибок: система должна отличать невалидный ответ AI от сбоя тестовой инфраструктуры, а пользователь не должен видеть сырой стек или приватное содержимое.
Чек-лист финальной проверки
- Синтетический вход и ожидаемый исход согласованы предметным владельцем.
- Команда
python scripts/check.pyработает локально и в CI на одной версии файлов. - Негативный случай обнаруживается, а не только успешный случай проходит.
- Имена ID и меток уникальны там, где этого требует контракт.
- В репозитории, логах и артефактах нет реальных секретов и приватных текстов.
- Понятно, какой дефект тест находит и каких выводов о качестве AI он не даёт.
- Ссылки на применённые функции и синтаксис workflow перепроверены при переносе.
FAQ
Почему не записать Q2 как ноль Recall?
Потому что причина до ранжирования — отсутствующий документ.
Можно исключить Q2 из отчёта?
Только с явным учётом таких случаев и объяснением.
Наличие ID гарантирует релевантность?
Нет, проверьте версию и содержимое.
Когда повторять оценку?
После восстановления индекса и сверки его снимка.
Что делать после обнаружения сбоя
Сохраните конкретный ID, воспроизведите его на текущей ревизии и отделите ошибку входных данных от ошибки функции. Если неверна контракт, исправьте её после предметного ревью; если неверен код, сначала оставьте проваливающийся тест, затем вносите исправление. После зелёного запуска просмотрите соседние случаи с похожими признаками, чтобы локальная правка не изменила другое согласованное поведение. Сохраните версии кода, набора и параметров запуска рядом с выводом: без них сравнивать результаты в будущем нельзя. Не приводите цифру из синтетического примера как измеренный показатель продукта.
Официальные первоисточники
Проверено 20.09.2026: 1, 2, 3, 4, 5. Описание переписано своими словами; изменяемые версии и поля нужно повторно сверять перед дальнейшим использованием.
Читайте также
Как исключить bias из weight decay через Optax
Optax 0.2.6: маска add_decayed_weights применяет decay к kernel и оставляет bias без изменения.
Как использовать Huber loss в Optax для регрессии с выбросами
Optax 0.2.6: Huber loss квадратичен около нуля и линеен после delta; проверяем ошибки 0,5 и 2.
Как использовать sigmoid focal loss в Optax
Optax 0.2.6: focal loss для logits 0 и labels 0/1 при gamma=2; проверка симметричного базового значения.
Комментарии
Пока тихо. Скажите первое слово