Class FunctionEvaluator<RecordType>

A class that constructs an evaluator based on an evaluate function.

Type Parameters

RecordType extends Record<string, unknown>

Hierarchy (View Summary)

EvaluatorBase<RecordType>
- FunctionEvaluator

Index

Constructors

Properties

evaluateFn inputMapping? kind name optimizationDirection? telemetry?

Methods

bindInputMapping evaluate

Constructors

constructor

new FunctionEvaluator<RecordType extends Record<string, unknown>>(
__namedParameters: FunctionEvaluatorArgs<RecordType>,
): FunctionEvaluator<RecordType>
Type Parameters
- RecordType extends Record<string, unknown>
Parameters
- __namedParameters: FunctionEvaluatorArgs<RecordType>
Returns FunctionEvaluator<RecordType>
Overrides EvaluatorBase.constructor
- Defined in core/FunctionEvaluator.ts:19

Properties

`Readonly`evaluateFn

evaluateFn: (args: RecordType) => Promise<EvaluationResult>

`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

bindInputMapping

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

evaluate

evaluate(args: RecordType): Promise<EvaluationResult>
The function that evaluates the example
Parameters
- args: RecordType
Returns Promise<EvaluationResult>
Overrides EvaluatorBase.evaluate
- Defined in core/FunctionEvaluator.ts:23