langsmith-cai/dist/evaluation/evaluator.d.ts

Client library to connect to the LangSmith LLM Tracing and Evaluation Platform.

import { Example, Run, ScoreType, ValueType } from "../schemas.js";
/**
 * Represents the result of an evaluation.
 */
export type EvaluationResult = {
    /**
     * The key associated with the evaluation result.
     */
    key: string;
    /**
     * The score of the evaluation result.
     */
    score?: ScoreType;
    /**
     * The value of the evaluation result.
     */
    value?: ValueType;
    /**
     * A comment associated with the evaluation result.
     */
    comment?: string;
    /**
     * A correction record associated with the evaluation result.
     */
    correction?: Record<string, unknown>;
    /**
     * Information about the evaluator.
     */
    evaluatorInfo?: Record<string, unknown>;
    /**
     * The source run ID of the evaluation result.
     * If set, a link to the source run will be available in the UI.
     */
    sourceRunId?: string;
    /**
     * The target run ID of the evaluation result.
     * If this is not set, the target run ID is assumed to be
     * the root of the trace.
     */
    targetRunId?: string;
};
export interface RunEvaluator {
    evaluateRun(run: Run, example?: Example): Promise<EvaluationResult>;
}