Как измерить MRR для 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. Определите глубину выдачи до расчёта и сохраните фактический порядок ID: сортировка после экспорта разрушит эксперимент. Запустите синтетические три случая и проверьте арифметику: первое попадание Q-21 находится на позиции 2. Затем подмените cases парными данными эталона и поискового индекса. При сравнении двух версий используйте одинаковый корпус вопросов, одинаковые фильтры доступа и одну глубину. Дополнительно покажите Q-23 как пропуск, чтобы средняя величина не скрыла конкретную неудачу.
4. Для регрессии положите тот же файл в репозиторий и добавьте workflow из второго блока в .github/workflows/rag-retrieval.yml. Проверка запускается на pull_request с разрешением contents: read; не передавайте в неё настоящие секреты и закрытые документы.
5. Откройте job retrieval-check в Actions на конкретном коммите. Сравните исходные ID и обнаруженные нарушения с локальным прогоном. При расхождении проверьте версию фикстур и скрипта, а не меняйте эталон до выяснения причины.

# scripts/check_retrieval.py
from statistics import fmean
cases = [
    ("Q-21", {"D-9"}, ["D-4","D-9","D-1"]),
    ("Q-22", {"D-2"}, ["D-2","D-3"]),
    ("Q-23", {"D-8"}, ["D-6","D-7"]),
]
def reciprocal_rank(gold, retrieved):
    if not gold or len(retrieved) != len(set(retrieved)):
        raise ValueError("invalid gold or duplicate retrieved ID")
    return next((1 / rank for rank, doc in enumerate(retrieved, 1)
                 if doc in gold), 0.0)
result = {qid:reciprocal_rank(gold, docs) for qid,gold,docs in cases}
assert result == {"Q-21":0.5,"Q-22":1.0,"Q-23":0.0}
assert fmean(result.values()) == 0.5
print(result, "demo MRR:", fmean(result.values()))

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-21: релевантный D-9, выдача D-4,D-9,D-1; Q-22: релевантный D-2, выдача D-2,D-3; Q-23: релевантный D-8, выдача D-6,D-7. Ожидаются 1/2, 1 и 0. После запуска ожидается исход, явно проверяемый инструкциями assert в коде. Не публикуйте вымышленное значение как измеренную характеристику вашей поисковой системы. Для рабочего отчёта приложите версию индекса, выбранные фильтры, размер размеченного набора, дату фиксации эталона и список ID провалившихся случаев. По каждому ID откройте первичный документ, прежде чем менять конфигурацию ранжирования: неправильно размеченный источник может выглядеть как технический дефект.

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

Если важны все релевантные документы, одного первого попадания недостаточно: используйте дополнительно Recall@k. При одинаковом MRR две системы могут иметь разное число полностью проваленных запросов. Значение 0.5 здесь — арифметика синтетической тройки, не реальная метрика продукта. При расширении теста сначала добавьте отрицательный случай: намеренно испортите один элемент фикстуры и убедитесь, что проверка обнаружила его. Затем верните исходный набор и проверьте положительный случай. Это важнее зелёного CI на данных, где ошибка случайно отсутствует. Не логируйте полный ответ модели, содержимое закрытых документов или персональные сведения только ради диагностики.

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

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

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