Package dev.braintrust.eval

Interface Dataset<INPUT,OUTPUT>

All Known Implementing Classes:

DatasetBrainstoreImpl

public interface Dataset<INPUT,OUTPUT>

Datasets define the cases for evals. This interface provides a means of iterating through all cases of a particular dataset.

The most common implementations are in-memory datasets, and datasets fetched from the Braintrust API.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	Dataset.Cursor<CASE>

Method Summary

Modifier and Type	Method	Description
static <INPUT, OUTPUT> Dataset<INPUT,OUTPUT>	fetchFromBraintrust(BraintrustApiClient apiClient, String projectName, String datasetName, String datasetVersion)
default void	forEach(Consumer<DatasetCase<INPUT,OUTPUT>> consumer)	Convenience method to safely iterate all items in a dataset.
String	id()
static <INPUT, OUTPUT> Dataset<INPUT,OUTPUT>	of(DatasetCase<INPUT,OUTPUT>... cases)	Create an in-memory Dataset containing the provided cases.
Dataset.Cursor<DatasetCase<INPUT,OUTPUT>>	openCursor()
Optional<String>	version()	Dataset version.

Method Details

openCursor

Dataset.Cursor<DatasetCase<INPUT,OUTPUT>> openCursor()

id

String id()

version

Optional<String> version()

Dataset version. Empty means the dataset will fetch latest upon every cursor open

forEach

default void forEach(Consumer<DatasetCase<INPUT,OUTPUT>> consumer)

Convenience method to safely iterate all items in a dataset.

of

@SafeVarargs
static <INPUT,
OUTPUT> Dataset<INPUT,OUTPUT> of(DatasetCase<INPUT,OUTPUT>... cases)

Create an in-memory Dataset containing the provided cases.

fetchFromBraintrust

static <INPUT,
OUTPUT> Dataset<INPUT,OUTPUT> fetchFromBraintrust(BraintrustApiClient apiClient,
 String projectName,
 String datasetName,
 @Nullable
 String datasetVersion)