Как посчитать Recall@K для поиска документов RAG

Перед запуском запишите, какие данные считаются входом, что является ожидаемым результатом, что именно означает отказ и кому предстоит разбирать расхождение. Для такой проверки храните тестовый вход, ожидаемый результат и фактический исход раздельно: если они смешаны, тест может подтверждать сам себя. Используйте стабильные синтетические ID, чтобы видеть ошибку в журнале, не раскрывая содержимое клиентских обращений.

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

Вход и ожидаемый результат

Эталон {A,C}, первые два результата [B,A] дают 1/2; первые два [B,D] дают 0. Первый список печатает Recall@2: 0.5; во втором первые два документа не совпадают с эталоном. Перед тем как применять правило к закрытым данным, обсудите пограничные случаи, которые могут поменять интерпретацию входа. Запись в документации о границах теста не менее важна, чем зелёный check.

Пошаговые действия

1. Создайте scripts/check.py в корне репозитория и вставьте код из блока ниже. Он использует названия функций стандартной библиотеки, указанные в официальных ссылках в конце статьи.
2. Выполните python scripts/check.py локально. Не продолжайте, если уже демонстрационная фикстура даёт иной результат: сначала проверьте копирование кода и кодировку файла.
3. Сначала выпишите для каждого вопроса допустимые документы вручную, сохраняя стабильные ID. Запустите фикстуру и убедитесь, что A на третьем месте не засчитывается при K=2. Добавьте отрицательный случай с повторённым ID: дубликат не должен притворяться двумя свидетельствами. На рабочем корпусе следите за устаревшими и недоступными документами в эталоне. Отчёт составляйте по вопросам, не объединяя все результаты в один список без привязки к запросам.
4. Создайте .github/workflows/ai-corpus-check.yml из YAML-шаблона. Событие pull_request полезно для проверки данных до слияния; чтение репозитория ограничено permissions: contents: read. Скрипт не должен получать ключ внешней модели или реальные секреты.
5. В разделе Actions откройте job check, сопоставьте его код завершения с локальным прогоном и зафиксируйте ссылку на проверенный коммит в PR. Не принимайте зелёный результат на старой ревизии за проверку последнего изменения.

# scripts/check.py
def recall_at_k(gold,ranked,k):
    if not gold or k<=0: raise ValueError("gold and k required")
    if len(ranked)!=len(set(ranked)): raise ValueError("duplicate document IDs")
    return len(set(ranked[:k]) & set(gold))/len(set(gold))
assert recall_at_k({"A","C"},["B","A","C"],2)==0.5
assert recall_at_k({"A","C"},["B","D","A"],2)==0
print("Recall@2:",recall_at_k({"A","C"},["B","A","C"],2))

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

Ошибки интерпретации и границы

Неполный эталон занижает качество поиска, если хороший документ забыли разметить. Recall@K не учитывает порядок внутри top-K и не гарантирует правильного ответа генератора. Если вы расширяете набор случаев, добавляйте не только новые примеры, но и отрицательные случаи, на которых тест обязан упасть. Проверяйте, что изменение expected прошло ревью отдельно от изменения кода: иначе можно незаметно изменить правило под текущий ответ системы. Избегайте вывода полного приватного набора в CI и не сохраняйте в артефактах ответ закрытой модели без решения о доступе и хранении.

Ошибка выполнения самого Python, нераспознанный формат входа и обнаруженный бизнес-дефект — разные ситуации. В сообщении теста указывайте тип проблемы и безопасный ID. Если тест требует внешний сервис, вынесите его из PR с недоверенным кодом и явно ограничьте доступ к токенам; этот пример намеренно работает локально. Перед публикацией каких-либо результатов опишите методику, область применения и происхождение примеров, иначе читатель воспримет демонстрационную арифметику как характеристику продукта.

Практический разбор именно этого контроля

Узнать, какую долю релевантных документов выдаёт поиск до передачи контекста модели. Для самостоятельной проверки сначала выпишите три наблюдаемых состояния: допустимый вход, намеренно недопустимый вход и видимый сигнал отказа. В данной фикстуре это выглядит так: Эталон {A,C}, первые два результата [B,A] дают 1/2; первые два [B,D] дают 0. При успешном тесте ожидается: Первый список печатает Recall@2: 0.5; во втором первые два документа не совпадают с эталоном. Не превращайте это в числовой KPI: здесь проверяется контракт на конкретных примерах, а не поведение модели на пользовательском трафике.

Неполный эталон занижает качество поиска, если хороший документ забыли разметить. Recall@K не учитывает порядок внутри top-K и не гарантирует правильного ответа генератора. Подключая проверку к продукту, расположите её до той операции, ради которой она написана: парсинга, сохранения, отображения или экспорта. Для каждого нового формата добавляйте отдельный негативный пример и письменное решение, почему он отклоняется. Отдельно просмотрите обработку ошибок: система должна отличать невалидный ответ AI от сбоя тестовой инфраструктуры, а пользователь не должен видеть сырой стек или приватное содержимое.