12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061 |
- import { Client } from "../index.js";
- import { ComparisonEvaluationResult as ComparisonEvaluationResultRow, Example, Run } from "../schemas.js";
- import { evaluate } from "./index.js";
- type ExperimentResults = Awaited<ReturnType<typeof evaluate>>;
- /** @deprecated Use ComparativeEvaluatorNew instead: (args: { runs, example, inputs, outputs, referenceOutputs }) => ... */
- export type _ComparativeEvaluatorLegacy = (runs: Run[], example: Example) => ComparisonEvaluationResultRow | Promise<ComparisonEvaluationResultRow>;
- export type _ComparativeEvaluator = (args: {
- runs: Run[];
- example: Example;
- inputs: Record<string, any>;
- outputs: Record<string, any>[];
- referenceOutputs?: Record<string, any>;
- }) => ComparisonEvaluationResultRow | Promise<ComparisonEvaluationResultRow>;
- export type ComparativeEvaluator = _ComparativeEvaluatorLegacy | _ComparativeEvaluator;
- export interface EvaluateComparativeOptions {
- /**
- * A list of evaluators to use for comparative evaluation.
- */
- evaluators: Array<ComparativeEvaluator>;
- /**
- * Randomize the order of outputs for each evaluation
- * @default false
- */
- randomizeOrder?: boolean;
- /**
- * The LangSmith client to use.
- * @default undefined
- */
- client?: Client;
- /**
- * Metadata to attach to the experiment.
- * @default undefined
- */
- metadata?: Record<string, unknown>;
- /**
- * A prefix to use for your experiment name.
- * @default undefined
- */
- experimentPrefix?: string;
- /**
- * A free-form description of the experiment.
- * @default undefined
- */
- description?: string;
- /**
- * Whether to load all child runs for the experiment.
- * @default false
- */
- loadNested?: boolean;
- /**
- * The maximum number of concurrent evaluators to run.
- * @default undefined
- */
- maxConcurrency?: number;
- }
- export interface ComparisonEvaluationResults {
- experimentName: string;
- results: ComparisonEvaluationResultRow[];
- }
- export declare function evaluateComparative(experiments: Array<string> | Array<Promise<ExperimentResults> | ExperimentResults>, options: EvaluateComparativeOptions): Promise<ComparisonEvaluationResults>;
- export {};
|