@arizeai/phoenix-evals/dist/src/code/createRecallEvaluator.js

A library for running evaluations for AI use cases

"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.createRecallEvaluator = createRecallEvaluator;
const classificationMetrics_1 = require("./classificationMetrics");
const createClassificationMetricEvaluator_1 = require("./createClassificationMetricEvaluator");
/**
 * Creates a code evaluator that computes recall: of the labels that actually
 * belong to a given class, the fraction the model correctly predicted.
 *
 * Supports binary classification (via `positiveLabel`, or auto-detected when
 * `average` is at its default `"macro"` and labels are the numeric set
 * `{0, 1}`) and multi-class classification (via the `average` strategy).
 *
 * @example
 * ```typescript
 * const recall = createRecallEvaluator();
 * const result = await recall.evaluate({
 *   expected: ["cat", "dog", "cat", "bird"],
 *   output: ["cat", "cat", "cat", "bird"],
 * });
 * // { score: 2/3 }
 * ```
 */
function createRecallEvaluator(options = {}) {
    const suffix = (0, classificationMetrics_1.getAverageMetricNameSuffix)(options);
    return (0, createClassificationMetricEvaluator_1.createClassificationMetricEvaluator)(`recall${suffix}`, "recall", options);
}
//# sourceMappingURL=createRecallEvaluator.js.map