Package dev.braintrust.devserver

Class RemoteEval.Parameter

java.lang.Object

dev.braintrust.devserver.RemoteEval.Parameter

Enclosing class:

RemoteEval<INPUT,OUTPUT>

public static class RemoteEval.Parameter
extends Object

Represents a configurable parameter for the evaluator

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	RemoteEval.Parameter.Builder

Method Summary

Modifier and Type	Method	Description
static RemoteEval.Parameter.Builder	builder()
static RemoteEval.Parameter	dataParameter(String description, Map<String,Object> schema, Object defaultValue)
static RemoteEval.Parameter	dataParameter(Map<String,Object> schema)
static RemoteEval.Parameter	dataParameter(Map<String,Object> schema, Object defaultValue)
Object	getDefaultValue()	Optional default value for the parameter
String	getDescription()	Optional description of the parameter
Map<String,Object>	getSchema()	JSON Schema for data type parameters.
RemoteEval.ParameterType	getType()	Type of parameter: "prompt" or "data"
static RemoteEval.Parameter	promptParameter(Object defaultValue)
static RemoteEval.Parameter	promptParameter(String description, Object defaultValue)

Methods inherited from class java.lang.Object

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

Method Details

promptParameter

public static RemoteEval.Parameter promptParameter(String description,
 Object defaultValue)

promptParameter

public static RemoteEval.Parameter promptParameter(Object defaultValue)

dataParameter

public static RemoteEval.Parameter dataParameter(String description,
 Map<String,Object> schema,
 Object defaultValue)

dataParameter

public static RemoteEval.Parameter dataParameter(Map<String,Object> schema,
 Object defaultValue)

dataParameter

public static RemoteEval.Parameter dataParameter(Map<String,Object> schema)

builder

public static RemoteEval.Parameter.Builder builder()

getType

@Nonnull
public RemoteEval.ParameterType getType()

Type of parameter: "prompt" or "data"

getDescription

@Nullable
public String getDescription()

Optional description of the parameter

getDefaultValue

@Nullable
public Object getDefaultValue()

Optional default value for the parameter

getSchema

@Nullable
public Map<String,Object> getSchema()

JSON Schema for data type parameters. Only applicable when type is DATA. Should be a Map representing a JSON Schema object.