Package dev.braintrust.api

Interface BraintrustApiClient

All Known Implementing Classes:

BraintrustApiClient.HttpImpl, BraintrustApiClient.InMemoryImpl

public interface BraintrustApiClient

Provides the necessary API calls for the Braintrust SDK. Users of the SDK should favor using Eval or BraintrustTracing

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final record	BraintrustApiClient.CreateDatasetRequest
static final record	BraintrustApiClient.CreateExperimentRequest
static final record	BraintrustApiClient.CreateProjectRequest
static final record	BraintrustApiClient.Dataset
static final record	BraintrustApiClient.DatasetEvent
static final record	BraintrustApiClient.DatasetFetchRequest
static final record	BraintrustApiClient.DatasetFetchResponse
static final record	BraintrustApiClient.DatasetList
static final record	BraintrustApiClient.Experiment
static final record	BraintrustApiClient.ExperimentList
static final record	BraintrustApiClient.Function	Represents a Braintrust function (scorer, prompt, tool, or task).
static final record	BraintrustApiClient.FunctionInvokeRequest	Request body for invoking a function.
static final record	BraintrustApiClient.FunctionListResponse
static class	BraintrustApiClient.HttpImpl
static class	BraintrustApiClient.InMemoryImpl	Implementation for test doubling
static final record	BraintrustApiClient.InsertEventsRequest
static final record	BraintrustApiClient.InsertEventsResponse
static final record	BraintrustApiClient.LoginRequest
static final record	BraintrustApiClient.LoginResponse
static final record	BraintrustApiClient.OrganizationAndProjectInfo
static final record	BraintrustApiClient.OrganizationInfo
static final record	BraintrustApiClient.Project
static final record	BraintrustApiClient.ProjectList
static final record	BraintrustApiClient.Prompt
static final record	BraintrustApiClient.PromptData
static final record	BraintrustApiClient.PromptListResponse

Method Summary

Modifier and Type	Method	Description
BraintrustApiClient.DatasetFetchResponse	fetchDatasetEvents(String datasetId, BraintrustApiClient.DatasetFetchRequest request)	Fetch dataset events with pagination
Optional<BraintrustApiClient.Dataset>	getDataset(String datasetId)	Get dataset metadata by ID
Optional<BraintrustApiClient.Function>	getFunction(String projectName, String slug, String version)	Get a function by project name and slug, with optional version.
BraintrustApiClient.Experiment	getOrCreateExperiment(BraintrustApiClient.CreateExperimentRequest request)	Creates an experiment.
BraintrustApiClient.Project	getOrCreateProject(String projectName)	Creates or gets a project by name.
BraintrustApiClient.OrganizationAndProjectInfo	getOrCreateProjectAndOrgInfo(BraintrustConfig config)	Get project and org info for the given config.
Optional<BraintrustApiClient.Project>	getProject(String projectId)	Gets a project by ID.
Optional<BraintrustApiClient.OrganizationAndProjectInfo>	getProjectAndOrgInfo()	Get project and org info for the default project ID
Optional<BraintrustApiClient.OrganizationAndProjectInfo>	getProjectAndOrgInfo(String projectId)	Get project and org info for the given project ID
Optional<BraintrustApiClient.Prompt>	getPrompt(String projectName, String slug, String version)	Get a prompt by slug and optional version
Object	invokeFunction(String functionId, BraintrustApiClient.FunctionInvokeRequest request)	Invoke a function (scorer, prompt, or tool) by its ID.
BraintrustApiClient.LoginResponse	login()	Attempt Braintrust login
static BraintrustApiClient	of(BraintrustConfig config)
List<BraintrustApiClient.Dataset>	queryDatasets(String projectName, String datasetName)	Query datasets by project name and dataset name

Method Details

login

BraintrustApiClient.LoginResponse login()
                                 throws LoginException

Attempt Braintrust login

Returns:

LoginResponse containing organization info

Throws:

LoginException - if login fails due to invalid credentials or network errors

getOrCreateProject

BraintrustApiClient.Project getOrCreateProject(String projectName)

Creates or gets a project by name.

getProject

Optional<BraintrustApiClient.Project> getProject(String projectId)

Gets a project by ID.

getOrCreateExperiment

BraintrustApiClient.Experiment getOrCreateExperiment(BraintrustApiClient.CreateExperimentRequest request)

Creates an experiment.

getProjectAndOrgInfo

Optional<BraintrustApiClient.OrganizationAndProjectInfo> getProjectAndOrgInfo()

Get project and org info for the default project ID

getProjectAndOrgInfo

Optional<BraintrustApiClient.OrganizationAndProjectInfo> getProjectAndOrgInfo(String projectId)

Get project and org info for the given project ID

getOrCreateProjectAndOrgInfo

BraintrustApiClient.OrganizationAndProjectInfo getOrCreateProjectAndOrgInfo(BraintrustConfig config)

Get project and org info for the given config. Creating them if necessary

getPrompt

Optional<BraintrustApiClient.Prompt> getPrompt(@Nonnull
 String projectName,
 @Nonnull
 String slug,
 @Nullable
 String version)

Get a prompt by slug and optional version

fetchDatasetEvents

BraintrustApiClient.DatasetFetchResponse fetchDatasetEvents(String datasetId,
 BraintrustApiClient.DatasetFetchRequest request)

Fetch dataset events with pagination

getDataset

Optional<BraintrustApiClient.Dataset> getDataset(String datasetId)

Get dataset metadata by ID

queryDatasets

List<BraintrustApiClient.Dataset> queryDatasets(String projectName,
 String datasetName)

Query datasets by project name and dataset name

getFunction

Optional<BraintrustApiClient.Function> getFunction(@Nonnull
 String projectName,
 @Nonnull
 String slug,
 @Nullable
 String version)

Get a function by project name and slug, with optional version.

Parameters:

projectName - the name of the project containing the function

slug - the unique slug identifier for the function

version - optional version identifier (transaction id or version string)

Returns:

the function if found

invokeFunction

Object invokeFunction(@Nonnull
 String functionId,
 @Nonnull
 BraintrustApiClient.FunctionInvokeRequest request)

Invoke a function (scorer, prompt, or tool) by its ID.

Parameters:

functionId - the ID of the function to invoke

request - the invocation request containing input, expected output, etc.

Returns:

the result of the function invocation

of

static BraintrustApiClient of(BraintrustConfig config)