Module: evaluation

Classes

• StringEvaluator

Interfaces

• EvaluateOptions
• GradingFunctionParams
• GradingFunctionResult
• RunEvaluator

Type Aliases

EvaluationResult

Ƭ EvaluationResult: Object

Represents the result of an evaluation.

Type declaration

Name	Type	Description
key	string	The key associated with the evaluation result.
comment?	string	A comment associated with the evaluation result.
correction?	Record<string, unknown>	A correction record associated with the evaluation result.
evaluatorInfo?	Record<string, unknown>	Information about the evaluator.
feedbackConfig?	FeedbackConfig	The feedback config associated with the evaluation result. If set, this will be used to define how a feedback key should be interpreted.
score?	ScoreType	The score of the evaluation result.
sourceRunId?	string	The source run ID of the evaluation result. If set, a link to the source run will be available in the UI.
targetRunId?	string	The target run ID of the evaluation result. If this is not set, the target run ID is assumed to be the root of the trace.
value?	ValueType	The value of the evaluation result.

Defined in

evaluation/evaluator.ts:29

Functions

evaluate

▸ evaluate(target, options): Promise<ExperimentResults>

Parameters

Name	Type	Description
target	TargetT	The target system or function to evaluate.
options	EvaluateOptions	-

Returns

Promise<ExperimentResults>

Defined in

evaluation/_runner.ts:109