Interface CreateClassificationEvaluatorArgs<RecordType>

The arguments for creating a classification-based evaluator

interface CreateClassificationEvaluatorArgs<
    RecordType extends Record<string, unknown>,
> {
    choices: ClassificationChoicesMap;
    inputMapping?: ObjectMapping<RecordType>;
    model: LanguageModel;
    name: string;
    optimizationDirection?: OptimizationDirection;
    promptTemplate: PromptTemplate;
    telemetry?: TelemetryConfig;
}

Type Parameters

  • RecordType extends Record<string, unknown>

Hierarchy (View Summary)

Properties

choices inputMapping? model name optimizationDirection? promptTemplate telemetry?

Properties

choices

choices: ClassificationChoicesMap

The choices to classify the example into. e.g. { "correct": 1, "incorrect": 0 }

OptionalinputMapping

inputMapping?: ObjectMapping<RecordType>

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

model

model: LanguageModel

name

name: string

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

OptionaloptimizationDirection

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.

promptTemplate

promptTemplate: PromptTemplate

The prompt template to use for classification

Optionaltelemetry

telemetry?: TelemetryConfig

Settings

Member Visibility

On This Page

Properties