mongodb-rag-core/build/eval/retrievalMetrics/precisionAtK.js

Common elements used by MongoDB Chatbot Framework components.

"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.precisionAtK = void 0;
const assertKIsValid_1 = require("./assertKIsValid");
/**
  Calculate Precision@K.
  Assesses the proportion of relevant items in the top-k retrievals.
  Precision@k focuses on how many of the top-k retrieved items are actually relevant.
  Each relevant item is counted only once, even if it appears multiple times.
  @param relevantItems - List of relevant items
  @param retrievedItems - List of retrieved items
  @param matchFunc - Function to compare items for equality
  @param k - Value of k (top-k results to consider)
  @returns Precision@k
 */
function precisionAtK(relevantItems, retrievedItems, matchFunc, k = 5) {
    (0, assertKIsValid_1.assertKIsValid)(k);
    if (retrievedItems.length === 0) {
        return 0;
    }
    const limit = Math.min(k, retrievedItems.length);
    // Ensure k is not greater than the number of retrieved items
    const topKRetrieved = retrievedItems.slice(0, k);
    const matchedRelevantItems = new Set(); // To track unique relevant items matched
    // Count unique relevant items in the top k predictions
    topKRetrieved.forEach((item) => {
        const match = relevantItems.find((relevantItem) => matchFunc(relevantItem, item) && !matchedRelevantItems.has(relevantItem));
        if (match) {
            matchedRelevantItems.add(match); // Add only the first match
        }
    });
    // Calculate precision@k
    const precision = matchedRelevantItems.size / limit;
    return precision;
}
exports.precisionAtK = precisionAtK;
//# sourceMappingURL=precisionAtK.js.map