Class EvaluatorBase<RecordType>`Abstract`

Base class for all evaluators

Type Parameters

RecordType extends Record<string, unknown>

Hierarchy (View Summary)

EvaluatorBase
- FunctionEvaluator
- LLMEvaluator

Implements

EvaluatorInterface<RecordType>

Index

Constructors

Properties

inputMapping? kind name optimizationDirection? telemetry?

Methods

bindInputMapping evaluate

Constructors

constructor

new EvaluatorBase<RecordType extends Record<string, unknown>>(
__namedParameters: CreateEvaluatorArgs<RecordType>,
): EvaluatorBase<RecordType>
Type Parameters
- RecordType extends Record<string, unknown>
Parameters
- __namedParameters: CreateEvaluatorArgs<RecordType>
Returns EvaluatorBase<RecordType>
- Defined in core/EvaluatorBase.ts:22

Properties

`Optional` `Readonly`inputMapping

inputMapping?: ObjectMapping<RecordType>

`Readonly`kind

kind: EvaluationKind

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

`Readonly`name

name: string

The name of the evaluator / the metric that it measures

`Optional` `Readonly`optimizationDirection

optimizationDirection?: OptimizationDirection

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

`Optional` `Readonly`telemetry

telemetry?: TelemetryConfig

Methods

`Abstract`bindInputMapping

bindInputMapping(
inputMapping: ObjectMapping<RecordType>,
): EvaluatorBase<RecordType>
Binds the input mapping to the evaluator. It makes a a copy of the evaluator and returns it.
Parameters
- inputMapping: ObjectMapping<RecordType>
Returns EvaluatorBase<RecordType>
- Defined in core/EvaluatorBase.ts:40

`Abstract`evaluate

evaluate(_example: RecordType): Promise<EvaluationResult>
The function that evaluates the example
Parameters
- _example: RecordType
Returns Promise<EvaluationResult>
Implementation of EvaluatorInterface.evaluate
- Defined in core/EvaluatorBase.ts:35