Как измерить покрытие вопросов источниками в RAG-корпусе

Шаблон входа для переноса примера на свою коллекцию: для каждого вопроса заведите поля id, question, expected_doc_ids, retrieved_doc_ids и, где требуется, index_version. Согласуйте с предметным владельцем, что именно считается релевантным, доступным и актуальным источником. Это рабочая схема сбора данных, а не универсальный формат API. В таблице ревью отдельно отметьте спорные случаи, которые нельзя разрешить одной лишь строковой операцией.

Пошаговая проверка

1. Создайте файл scripts/check_retrieval.py; скопируйте Python-шаблон целиком. Использованные названия библиотечных функций сверены с официальными страницами в конце статьи.
2. Запустите python scripts/check_retrieval.py локально. Сопоставьте консольный вывод с ожидаемым результатом в описании входа; демонстрация обязана проходить без внешнего API и ключей.
3. Составьте список реальных вопросов и заранее зафиксируйте версию корпуса, к которой относится разметка. Выполните демонстрационный скрипт и внесите преднамеренную ошибку: поставьте Q-42 answerable=true, не указав gold, — аудит должен остановиться. Верните правильную запись и разметьте каждый живой кейс человеком по доступным документам. Для вопросов без источника предусмотрите маршрут на пополнение базы или честный отказ; не включайте их в Recall@k как нули поисковой системы. Храните дату и происхождение gold_doc_ids.
4. Для регрессии положите тот же файл в репозиторий и добавьте workflow из второго блока в .github/workflows/rag-retrieval.yml. Проверка запускается на pull_request с разрешением contents: read; не передавайте в неё настоящие секреты и закрытые документы.
5. Откройте job retrieval-check в Actions на конкретном коммите. Сравните исходные ID и обнаруженные нарушения с локальным прогоном. При расхождении проверьте версию фикстур и скрипта, а не меняйте эталон до выяснения причины.

# scripts/check_retrieval.py
from collections import Counter
cases = [
    {"id":"Q-41","answerable":True,"gold":{"D-1"}},
    {"id":"Q-42","answerable":False,"gold":set()},
    {"id":"Q-43","answerable":True,"gold":{"D-3"}},
]
def audit(rows):
    if len({r["id"] for r in rows}) != len(rows):
        raise ValueError("duplicate question ID")
    for r in rows:
        if not isinstance(r["answerable"], bool):
            raise ValueError("answerable must be boolean")
        if r["answerable"] != bool(r["gold"]):
            raise ValueError("inconsistent gold for " + r["id"])
    return Counter("answerable" if r["answerable"] else "no_source"
                   for r in rows)
counts = audit(cases)
assert counts == {"answerable":2,"no_source":1}
print("Synthetic corpus coverage:", counts)

name: RAG retrieval contract
on:
  pull_request:
permissions:
  contents: read
jobs:
  retrieval-check:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v7
      - uses: actions/setup-python@v7
        with:
          python-version: '3.13'
      - run: python scripts/check_retrieval.py

Реалистичный пример результата

Вход: Q-41 про доставку имеет D-1; Q-42 про услугу, не описанную в базе, помечен unanswerable; Q-43 про возврат имеет D-3. Ожидается два answerable и один unanswerable. После запуска ожидается исход, явно проверяемый инструкциями assert в коде. Не публикуйте вымышленное значение как измеренную характеристику вашей поисковой системы. Для рабочего отчёта приложите версию индекса, выбранные фильтры, размер размеченного набора, дату фиксации эталона и список ID провалившихся случаев. По каждому ID откройте первичный документ, прежде чем менять конфигурацию ранжирования: неправильно размеченный источник может выглядеть как технический дефект.

Типовые ошибки и ограничения

Покрытие корпуса не равно доле вопросов, на которые генератор ответит правильно, и не является оценкой спроса без репрезентативной выборки. Наличие документа не означает достаточности его содержания. Владелец знаний должен подтверждать answerable и пересматривать статус после обновления базы. При расширении теста сначала добавьте отрицательный случай: намеренно испортите один элемент фикстуры и убедитесь, что проверка обнаружила его. Затем верните исходный набор и проверьте положительный случай. Это важнее зелёного CI на данных, где ошибка случайно отсутствует. Не логируйте полный ответ модели, содержимое закрытых документов или персональные сведения только ради диагностики.

Отдельно разделяйте ошибку данных, ошибку ранжирования и ошибку генерации. Если тест выполняется на другом индексе или другой редакции источника, результат нельзя напрямую сравнить с предыдущим. Снимок исходной выдачи, код и эталон должны относиться к одному запросу и одной версии доступных документов. Указанный демонстрационный результат не устанавливает порог качества для бизнеса; порог согласуют по отдельному размеченному набору и цене ошибки.

Чек-лист финальной проверки

• Задача теста и применимость понятны владельцу корпуса.
• Входные ID и эталон не взяты из ответа оцениваемой модели.
• Демо запускается локально и даёт ожидаемый результат.
• Преднамеренно неверный вход обнаруживается проверкой.
• Зафиксированы версия индекса, редакция документов и условия доступа.
• В логах CI нет приватных документов и секретов.
• Разделены ошибка поиска, ошибка эталона и ошибка генерации.
• После исправления проверены соседние пограничные случаи.