@arizeai/phoenix-evals/dist/src/llm/createUserFrictionEvaluator.js

A library for running evaluations for AI use cases

"use strict";
var __rest = (this && this.__rest) || function (s, e) {
    var t = {};
    for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
        t[p] = s[p];
    if (s != null && typeof Object.getOwnPropertySymbols === "function")
        for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
            if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
                t[p[i]] = s[p[i]];
        }
    return t;
};
Object.defineProperty(exports, "__esModule", { value: true });
exports.createUserFrictionEvaluator = createUserFrictionEvaluator;
const default_templates_1 = require("../__generated__/default_templates");
const createClassificationEvaluator_1 = require("./createClassificationEvaluator");
/**
 * Creates a user friction evaluator function.
 *
 * This function returns an evaluator that detects expressed user friction
 * with an assistant's preceding behavior, such as corrections, retries,
 * frustration, and challenges to unrequested or unexplained actions.
 *
 * @param args - The arguments for creating the user friction evaluator.
 * @param args.model - The model to use for classification.
 * @param args.choices - The possible classification choices (defaults to friction/no_friction).
 * @param args.promptTemplate - The prompt template to use (defaults to USER_FRICTION_CLASSIFICATION_EVALUATOR_CONFIG.template).
 * @param args.telemetry - The telemetry to use for the evaluator.
 *
 * @returns An evaluator function that takes a {@link UserFrictionEvaluationRecord} and returns a classification result
 * indicating whether the latest user message expresses friction or no friction.
 *
 * @example
 * ```ts
 * const evaluator = createUserFrictionEvaluator({ model: openai("gpt-4o-mini") });
 * const result = await evaluator.evaluate({
 *   conversation: "User: Show recent orders.\nAssistant: Here are last month's orders.",
 *   userMessage: "No, I asked for this week.",
 * });
 * console.log(result.label); // "friction"
 * ```
 */
function createUserFrictionEvaluator(args) {
    const { choices = default_templates_1.USER_FRICTION_CLASSIFICATION_EVALUATOR_CONFIG.choices, promptTemplate = default_templates_1.USER_FRICTION_CLASSIFICATION_EVALUATOR_CONFIG.template, optimizationDirection = default_templates_1.USER_FRICTION_CLASSIFICATION_EVALUATOR_CONFIG.optimizationDirection, name = default_templates_1.USER_FRICTION_CLASSIFICATION_EVALUATOR_CONFIG.name } = args, rest = __rest(args, ["choices", "promptTemplate", "optimizationDirection", "name"]);
    return (0, createClassificationEvaluator_1.createClassificationEvaluator)(Object.assign(Object.assign({}, rest), { promptTemplate,
        choices,
        optimizationDirection,
        name }));
}
//# sourceMappingURL=createUserFrictionEvaluator.js.map