Package dev.braintrust.api

Interface BraintrustApiClient

All Known Implementing Classes:

BraintrustApiClient.HttpImpl

@Deprecated
public interface BraintrustApiClient

Deprecated.

Deprecated. Please use BraintrustOpenApiClient instead

Nested Class Summary

Nested Classes

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

Method Summary

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

Method Details

openApiClient

@Deprecated
BraintrustOpenApiClient openApiClient()

Deprecated.

Create an openapi client with the same api key as this one.

Convenience method for migrating to the new client. It's recommended to not use this method and simply migrate to the new BraintrustOpenApiClient

login

BraintrustApiClient.LoginResponse login()
                                 throws LoginException

Deprecated.

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)

Deprecated.

Creates or gets a project by name.

getProject

Optional<BraintrustApiClient.Project> getProject(String projectId)

Deprecated.

Gets a project by ID.

getOrCreateExperiment

BraintrustApiClient.Experiment getOrCreateExperiment(BraintrustApiClient.CreateExperimentRequest request)

Deprecated.

Creates an experiment.

listExperiments

List<BraintrustApiClient.Experiment> listExperiments(String projectId)

Deprecated.

Lists experiments for a project.

getProjectAndOrgInfo

Optional<BraintrustApiClient.OrganizationAndProjectInfo> getProjectAndOrgInfo()

Deprecated.

Get project and org info for the default project ID

getProjectAndOrgInfo

Optional<BraintrustApiClient.OrganizationAndProjectInfo> getProjectAndOrgInfo(String projectId)

Deprecated.

Get project and org info for the given project ID

getOrCreateProjectAndOrgInfo

BraintrustApiClient.OrganizationAndProjectInfo getOrCreateProjectAndOrgInfo(BraintrustConfig config)

Deprecated.

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)

Deprecated.

Get a prompt by slug and optional version

fetchDatasetEvents

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

Deprecated.

Fetch dataset events with pagination

getDataset

Optional<BraintrustApiClient.Dataset> getDataset(String datasetId)

Deprecated.

Get dataset metadata by ID

queryDatasets

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

Deprecated.

Query datasets by project name and dataset name

getFunction

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

Deprecated.

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

getFunctionById

Optional<BraintrustApiClient.Function> getFunctionById(@Nonnull
 String functionId)

Deprecated.

Get a function by its ID.

Parameters:

functionId - the ID of the function

Returns:

the function if found

invokeFunction

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

Deprecated.

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

btqlQuery

BraintrustApiClient.BtqlQueryResponse btqlQuery(@Nonnull
 String query)

Deprecated.

Execute a BTQL (Braintrust Query Language) query. Supports both BTQL pipe syntax and standard SQL syntax.

Parameters:

query - the BTQL/SQL query string

Returns:

the query result containing rows of data

of

static BraintrustApiClient of(BraintrustConfig config)

Deprecated.