@arizeai/phoenix-evals
Version:
A library for running evaluations for AI use cases
24 lines • 1.48 kB
TypeScript
import type { CreateClassificationEvaluatorArgs } from "../types/evals";
import type { ClassificationEvaluator } from "./ClassificationEvaluator";
export interface FaithfulnessEvaluatorArgs<RecordType extends Record<string, unknown> = FaithfulnessEvaluationRecord> extends Omit<CreateClassificationEvaluatorArgs<RecordType>, "promptTemplate" | "choices" | "optimizationDirection" | "name"> {
optimizationDirection?: CreateClassificationEvaluatorArgs<RecordType>["optimizationDirection"];
name?: CreateClassificationEvaluatorArgs<RecordType>["name"];
choices?: CreateClassificationEvaluatorArgs<RecordType>["choices"];
promptTemplate?: CreateClassificationEvaluatorArgs<RecordType>["promptTemplate"];
}
/**
* A record to be evaluated by the faithfulness evaluator.
*/
export type FaithfulnessEvaluationRecord = {
input: string;
output: string;
context?: string;
};
/**
* Creates a function that evaluates whether an answer is faithful or unfaithful based on a query and reference text.
*
* @param args - The arguments for creating the faithfulness evaluator.
* @returns A function that evaluates whether an answer is faithful or unfaithful based on a query and reference text.
*/
export declare function createFaithfulnessEvaluator<RecordType extends Record<string, unknown> = FaithfulnessEvaluationRecord>(args: FaithfulnessEvaluatorArgs<RecordType>): ClassificationEvaluator<RecordType>;
//# sourceMappingURL=createFaithfulnessEvaluator.d.ts.map