Interface CreateEvaluatorArgs<ExampleType>

interface CreateEvaluatorArgs<
    ExampleType extends Record<string, unknown> = Record<string, unknown>,
> {
    inputMapping?: ObjectMapping<ExampleType>;
    kind: EvaluationKind;
    name: string;
    optimizationDirection?: OptimizationDirection;
    telemetry?: TelemetryConfig;
}

Type Parameters

ExampleType extends Record<string, unknown> = Record<string, unknown>

Hierarchy (View Summary)

WithTelemetry
- CreateEvaluatorArgs

Index

Properties

inputMapping? kind name optimizationDirection? telemetry?

Properties

`Optional`inputMapping

inputMapping?: ObjectMapping<ExampleType>

The mapping of the input to evaluate to the shape that the evaluator expects

kind

kind: EvaluationKind

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

name

name: string

The name of the metric that the evaluator produces E.x. "correctness"

`Optional`optimizationDirection

optimizationDirection?: OptimizationDirection

If present, represents the direction in which you want the metric to be optimized E.x. "MAXIMIZE" means you want the number to be higher.

`Optional`telemetry

telemetry?: TelemetryConfig