Package dev.braintrust.eval

Class Eval.Builder<INPUT,OUTPUT>

java.lang.Object

dev.braintrust.eval.Eval.Builder<INPUT,OUTPUT>

Enclosing class:

Eval<INPUT,OUTPUT>

public static final class Eval.Builder<INPUT,OUTPUT>
extends Object

Builder for creating evaluations with fluent API.

Field Summary

Fields

Modifier and Type	Field	Description
Dataset<INPUT,OUTPUT>	dataset

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
Eval.Builder<INPUT,OUTPUT>	apiClient(BraintrustApiClient apiClient)	Deprecated.
Eval.Builder<INPUT,OUTPUT>	apiClient(BraintrustOpenApiClient apiClient)
Eval<INPUT,OUTPUT>	build()
final Eval.Builder<INPUT,OUTPUT>	cases(DatasetCase<INPUT,OUTPUT>... cases)
final Eval.Builder<INPUT,OUTPUT>	cases(EvalCase<INPUT,OUTPUT>... cases)	Deprecated.
final Eval.Builder<INPUT,OUTPUT>	classifiers(Classifier<INPUT,OUTPUT>... classifiers)
Eval.Builder<INPUT,OUTPUT>	config(BraintrustConfig config)
Eval.Builder<INPUT,OUTPUT>	dataset(Dataset<INPUT,OUTPUT> dataset)
Eval.Builder<INPUT,OUTPUT>	metadata(Map<String,Object> metadata)	Sets metadata for the experiment.
Eval.Builder<INPUT,OUTPUT>	name(String name)
Eval.Builder<INPUT,OUTPUT>	parameters(ParameterDef<?>... parameterDefs)	Sets parameter definitions for this eval.
Eval.Builder<INPUT,OUTPUT>	parameters(List<ParameterDef<?>> parameterDefs)	Sets parameter definitions for this eval.
Eval.Builder<INPUT,OUTPUT>	parameterValues(Map<String,Object> values)	Sets explicit parameter values, overriding any defaults from parameter definitions.
Eval.Builder<INPUT,OUTPUT>	projectId(String projectId)
final Eval.Builder<INPUT,OUTPUT>	scorers(Scorer<INPUT,OUTPUT>... scorers)
Eval.Builder<INPUT,OUTPUT>	tags(String... tags)	Sets tags for the experiment (varargs convenience method).
Eval.Builder<INPUT,OUTPUT>	tags(List<String> tags)	Sets tags for the experiment.
Eval.Builder<INPUT,OUTPUT>	task(Task<INPUT,OUTPUT> task)
Eval.Builder<INPUT,OUTPUT>	taskFunction(Function<INPUT,OUTPUT> taskFn)
Eval.Builder<INPUT,OUTPUT>	tracer(io.opentelemetry.api.trace.Tracer tracer)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

dataset

@Nonnull
public Dataset<INPUT,OUTPUT> dataset

Constructor Details

Builder

public Builder()

Method Details

build

public Eval<INPUT,OUTPUT> build()

name

public Eval.Builder<INPUT,OUTPUT> name(@Nonnull
 String name)

projectId

public Eval.Builder<INPUT,OUTPUT> projectId(@Nonnull
 String projectId)

config

public Eval.Builder<INPUT,OUTPUT> config(BraintrustConfig config)

apiClient

public Eval.Builder<INPUT,OUTPUT> apiClient(BraintrustOpenApiClient apiClient)

apiClient

@Deprecated
public Eval.Builder<INPUT,OUTPUT> apiClient(BraintrustApiClient apiClient)

Deprecated.

tracer

public Eval.Builder<INPUT,OUTPUT> tracer(io.opentelemetry.api.trace.Tracer tracer)

dataset

public Eval.Builder<INPUT,OUTPUT> dataset(Dataset<INPUT,OUTPUT> dataset)

cases

@Deprecated
@SafeVarargs
public final Eval.Builder<INPUT,OUTPUT> cases(EvalCase<INPUT,OUTPUT>... cases)

Deprecated.

Deprecated. Use cases(DatasetCase[]) or dataset(Dataset) instead

cases

@SafeVarargs
public final Eval.Builder<INPUT,OUTPUT> cases(DatasetCase<INPUT,OUTPUT>... cases)

task

public Eval.Builder<INPUT,OUTPUT> task(Task<INPUT,OUTPUT> task)

taskFunction

public Eval.Builder<INPUT,OUTPUT> taskFunction(Function<INPUT,OUTPUT> taskFn)

scorers

@SafeVarargs
public final Eval.Builder<INPUT,OUTPUT> scorers(Scorer<INPUT,OUTPUT>... scorers)

classifiers

@SafeVarargs
public final Eval.Builder<INPUT,OUTPUT> classifiers(Classifier<INPUT,OUTPUT>... classifiers)

tags

public Eval.Builder<INPUT,OUTPUT> tags(List<String> tags)

Sets tags for the experiment.

tags

public Eval.Builder<INPUT,OUTPUT> tags(String... tags)

Sets tags for the experiment (varargs convenience method).

metadata

public Eval.Builder<INPUT,OUTPUT> metadata(Map<String,Object> metadata)

Sets metadata for the experiment.

parameters

public Eval.Builder<INPUT,OUTPUT> parameters(ParameterDef<?>... parameterDefs)

Sets parameter definitions for this eval. Default values from the definitions are used unless overridden via parameterValues(Map).

parameters

public Eval.Builder<INPUT,OUTPUT> parameters(List<ParameterDef<?>> parameterDefs)

Sets parameter definitions for this eval.

parameterValues

public Eval.Builder<INPUT,OUTPUT> parameterValues(Map<String,Object> values)

Sets explicit parameter values, overriding any defaults from parameter definitions. Keys not present here fall back to the default value from the corresponding ParameterDef.