Interface EvaluatorInterface<ExampleType>

The Base Evaluator interface This is the interface that all evaluators must implement

interface EvaluatorInterface<ExampleType extends Record<string, unknown>> {
    evaluate: EvaluatorFn<ExampleType>;
    kind: EvaluationKind;
    name: string;
    optimizationDirection?: OptimizationDirection;
}

Type Parameters

ExampleType extends Record<string, unknown>

Hierarchy

EvaluatorDescription
- EvaluatorInterface

Implemented by

EvaluatorBase

Index

Properties

evaluate kind name optimizationDirection?

Properties

evaluate

evaluate: EvaluatorFn<ExampleType>

The function that evaluates the example

kind

kind: EvaluationKind

The kind of the evaluation. Also known as the "kind" of evaluator.

name

name: string

The name of the evaluator / the metric that it measures

`Optional`optimizationDirection

optimizationDirection?: OptimizationDirection

The direction to optimize the numeric evaluation score E.x. "MAXIMIZE" means that the higher the score, the better the evaluation