ReferenceSDKTypescriptInterfacesReporterBody

Interface: ReporterBody<EvalReport>

Type parameters

Name
EvalReport

Methods

reportEval

reportEval(evaluator, result, opts): EvalReport | Promise<EvalReport>

A function that takes an evaluator and its result and returns a report.

Parameters

NameType
evaluatorEvaluatorDef<any, any, any, any>
resultEvalResultWithSummary<any, any, any, any>
optsReporterOpts

Returns

EvalReport | Promise<EvalReport>


reportRun

reportRun(reports): boolean | Promise<boolean>

A function that takes all evaluator results and returns a boolean indicating whether the run was successful. If you return false, the braintrust eval command will exit with a non-zero status code.

Parameters

NameType
reportsEvalReport[]

Returns

boolean | Promise<boolean>

On this page