Как рассчитать Precision@K для контекста RAG

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

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

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

При эталоне {A,C}, выдаче [A,B,C] и K=2 результат 1/2; при K=3 — 2/3. Для A,B,C в top-2 печатается P@2: 0.5; для top-3 получается приблизительно 0.667. Перед тем как применять правило к закрытым данным, обсудите пограничные случаи, которые могут поменять интерпретацию входа. Запись в документации о границах теста не менее важна, чем зелёный check.

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

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

# scripts/check.py
def precision_at_k(gold,ranked,k):
    if k<=0: raise ValueError("k must be positive")
    if len(ranked)!=len(set(ranked)): raise ValueError("duplicate IDs")
    return sum(doc in gold for doc in ranked[:k])/k
assert precision_at_k({"A","C"},["A","B","C"],2)==0.5
assert abs(precision_at_k({"A","C"},["A","B","C"],3)-2/3)<1e-12
assert precision_at_k({"A"},["A"],2)==0.5
print("P@2:",precision_at_k({"A","C"},["A","B","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

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

Определение для выдачи короче K нужно объявить заранее. Релевантный документ может быть устаревшим или запрещённым пользователю: доступ и актуальность проверяются отдельно. Если вы расширяете набор случаев, добавляйте не только новые примеры, но и отрицательные случаи, на которых тест обязан упасть. Проверяйте, что изменение expected прошло ревью отдельно от изменения кода: иначе можно незаметно изменить правило под текущий ответ системы. Избегайте вывода полного приватного набора в CI и не сохраняйте в артефактах ответ закрытой модели без решения о доступе и хранении.

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

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

Оценить, сколько нерелевантных документов попадает в окно контекста. Для самостоятельной проверки сначала выпишите три наблюдаемых состояния: допустимый вход, намеренно недопустимый вход и видимый сигнал отказа. В данной фикстуре это выглядит так: При эталоне {A,C}, выдаче [A,B,C] и K=2 результат 1/2; при K=3 — 2/3. При успешном тесте ожидается: Для A,B,C в top-2 печатается P@2: 0.5; для top-3 получается приблизительно 0.667. Не превращайте это в числовой KPI: здесь проверяется контракт на конкретных примерах, а не поведение модели на пользовательском трафике.

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