judgeval/dist/types/evaluation-run.d.ts

Judgment SDK for TypeScript/JavaScript

import { Example } from './data/example.js';
import { APIJudgmentScorer, JudgevalScorer } from './scorers/base-scorer.js';
import { Rule } from './rules.js';
/**
 * Stores example and evaluation scorers together for running an eval task
 */
export interface EvaluationRunOptions {
    logResults?: boolean;
    organizationId?: string;
    projectName?: string;
    evalName?: string;
    examples: Example[];
    scorers: Array<APIJudgmentScorer | JudgevalScorer>;
    model: string | string[] | any;
    aggregator?: string;
    metadata?: Record<string, any>;
    judgmentApiKey?: string;
    override?: boolean;
    rules?: Rule[];
}
export declare class EvaluationRun {
    logResults: boolean;
    organizationId?: string;
    projectName?: string;
    evalName?: string;
    examples: Example[];
    scorers: Array<APIJudgmentScorer | JudgevalScorer>;
    model: string | string[] | any;
    aggregator?: string;
    metadata?: Record<string, any>;
    judgmentApiKey?: string;
    override?: boolean;
    rules?: Rule[];
    constructor(options: EvaluationRunOptions);
    /**
     * Validate the evaluation run configuration
     */
    private validate;
    /**
     * Convert the evaluation run to a plain object
     *
     */
    toJSON(): Record<string, any>;
}