Package dev.braintrust.api

Class BraintrustOpenApiClient

java.lang.Object

dev.braintrust.openapi.ApiClient

dev.braintrust.api.BraintrustOpenApiClient

public class BraintrustOpenApiClient
extends dev.braintrust.openapi.ApiClient

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	Class	Description
static final record	BraintrustOpenApiClient.BtqlQueryResponse	Response from a POST /btql query.
static final record	BraintrustOpenApiClient.FreshnessState
static final record	BraintrustOpenApiClient.LoginResponse
static final record	BraintrustOpenApiClient.OrgInfo
static final record	BraintrustOpenApiClient.RealtimeState	Real-time indexing state for a BTQL query.

Field Summary

Fields inherited from class dev.braintrust.openapi.ApiClient

asyncResponseInterceptor, basePath, builder, connectTimeout, host, interceptor, mapper, port, readTimeout, responseInterceptor, scheme

Method Summary

Modifier and Type	Method	Description
BraintrustOpenApiClient.BtqlQueryResponse	btqlQuery(String query)	Calls POST /btql to run an arbitrary BTQL query.
dev.braintrust.openapi.model.Project	fetchOrCreateProject(BraintrustConfig config)
dev.braintrust.openapi.model.Project	fetchOrCreateProject(String projectId, String projectName)
BraintrustOpenApiClient.OrgInfo	fetchOrgInfo(String orgId)
URI	fetchProjectUri()	Look up or create the project from config, resolve the org name via login, and return the Braintrust app URI for the project.
BraintrustOpenApiClient.LoginResponse	login()	Calls POST /api/apikey/login to retrieve organization info for the current API key.
static BraintrustOpenApiClient	of(BraintrustConfig config)

Methods inherited from class dev.braintrust.openapi.ApiClient

createDefaultHttpClientBuilder, createDefaultObjectMapper, getAsyncResponseInterceptor, getBaseUri, getConnectTimeout, getDefaultBaseUri, getHttpClient, getObjectMapper, getReadTimeout, getRequestInterceptor, getResponseInterceptor, parameterToPairs, parameterToPairs, setAsyncResponseInterceptor, setBasePath, setConnectTimeout, setHost, setHttpClientBuilder, setObjectMapper, setPort, setReadTimeout, setRequestInterceptor, setResponseInterceptor, setScheme, updateBaseUri, urlEncode, valueToString

Methods inherited from class java.lang.Object

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

Method Details

of

public static BraintrustOpenApiClient of(BraintrustConfig config)

login

public BraintrustOpenApiClient.LoginResponse login()

Calls POST /api/apikey/login to retrieve organization info for the current API key. This endpoint is not in the OpenAPI spec so it is implemented here as a custom method.

fetchProjectUri

public URI fetchProjectUri()

Look up or create the project from config, resolve the org name via login, and return the Braintrust app URI for the project.

fetchOrgInfo

public BraintrustOpenApiClient.OrgInfo fetchOrgInfo(String orgId)

fetchOrCreateProject

public dev.braintrust.openapi.model.Project fetchOrCreateProject(BraintrustConfig config)

fetchOrCreateProject

public dev.braintrust.openapi.model.Project fetchOrCreateProject(@Nullable
 String projectId,
 @Nullable
 String projectName)

btqlQuery

public BraintrustOpenApiClient.BtqlQueryResponse btqlQuery(String query)

Calls POST /btql to run an arbitrary BTQL query. This endpoint is not in the OpenAPI spec so it is implemented here as a custom method.