The Braintrust Kotlin SDK provides convenient access to the Braintrust REST API from applications written in Kotlin. It includes helper classes with helpful types and documentation for every request and response property.
The Braintrust Kotlin SDK is similar to the Braintrust Java SDK but with minor differences that make it more ergonomic for use in Kotlin, such as nullable values instead of Optional, Sequence instead of Stream, and suspend functions instead of CompletableFuture.
It is generated with Stainless.
The REST API documentation can be found on www.braintrustdata.com.
implementation("com.braintrustdata.api:braintrust-kotlin:0.3.0")<dependency>
<groupId>com.braintrustdata.api</groupId>
<artifactId>braintrust-kotlin</artifactId>
<version>0.3.0</version>
</dependency>Use BraintrustOkHttpClient.builder() to configure the client.
Alternately, set the environment with BRAINTRUST_API_KEY, and use BraintrustOkHttpClient.fromEnv() to read from the environment.
val client = BraintrustOkHttpClient.fromEnv()
// Note: you can also call fromEnv() from the client builder, for example if you need to set additional properties
val client = BraintrustOkHttpClient.builder()
.fromEnv()
// ... set properties on the builder
.build()| Property | Environment variable | Required | Default value |
|---|---|---|---|
| apiKey | BRAINTRUST_API_KEY |
false | — |
Read the documentation for more configuration options.
To create a new project, first use the ProjectCreateParams builder to specify attributes,
then pass that to the create method of the projects service.
import com.braintrustdata.api.models.Project
import com.braintrustdata.api.models.ProjectCreateParams
val params = ProjectCreateParams.builder()
.name("foobar")
.build()
val project = client.projects().create(params)The Braintrust API provides a list method to get a paginated list of projects.
You can retrieve the first page by:
import com.braintrustdata.api.models.Page
import com.braintrustdata.api.models.Project
val page = client.projects().list()
for (project: Project in page.objects()) {
print(project)
}See Pagination below for more information on transparently working with lists of objects without worrying about fetching each page.
To make a request to the Braintrust API, you generally build an instance of the appropriate Params class.
In Example: creating a resource above, we used the ProjectCreateParams.builder() to pass to
the create method of the projects service.
Sometimes, the API may support other properties that are not yet supported in the Kotlin SDK types. In that case,
you can attach them using the putAdditionalProperty method.
import com.braintrustdata.api.models.core.JsonValue
val params = ProjectCreateParams.builder()
// ... normal properties
.putAdditionalProperty("secret_param", JsonValue.from("4242"))
.build()When receiving a response, the Braintrust Kotlin SDK will deserialize it into instances of the typed model classes. In rare cases, the API may return a response property that doesn't match the expected Kotlin type. If you directly access the mistaken property, the SDK will throw an unchecked BraintrustInvalidDataException at runtime. If you would prefer to check in advance that that response is completely well-typed, call .validate() on the returned model.
val project = client.projects().create().validate()In rare cases, you may want to access the underlying JSON value for a response property rather than using the typed version provided by
this SDK. Each model property has a corresponding JSON version, with an underscore before the method name, which returns a JsonField value.
val field = responseObj._field
if (field.isMissing()) {
// Value was not specified in the JSON response
} else if (field.isNull()) {
// Value was provided as a literal null
} else {
// See if value was provided as a string
val jsonString: String? = field.asString();
// If the value given by the API did not match the shape that the SDK expects
// you can deserialise into a custom type
val myObj = responseObj._field.asUnknown()?.convert(MyClass.class)
}Sometimes, the server response may include additional properties that are not yet available in this library's types. You can access them using the model's _additionalProperties method:
val secret = aISecret._additionalProperties().get("secret_field")For methods that return a paginated list of results, this library provides convenient ways access the results either one page at a time, or item-by-item across all pages.
To iterate through all results across all pages, you can use autoPager,
which automatically handles fetching more pages for you:
// As a Sequence:
client.projects().list(params).autoPager()
.take(50)
.forEach { project -> print(project) }// As a Flow:
asyncClient.projects().list(params).autoPager()
.take(50)
.collect { project -> print(project) }If none of the above helpers meet your needs, you can also manually request pages one-by-one.
A page of results has a data() method to fetch the list of objects, as well as top-level
response and other methods to fetch top-level data about the page. It also has methods
hasNextPage, getNextPage, and getNextPageParams methods to help with pagination.
val page = client.projects().list(params)
while (page != null) {
for (project in page.objects) {
print(project)
}
page = page.getNextPage()
}This library throws exceptions in a single hierarchy for easy handling:
-
BraintrustException- Base exception for all exceptions-
BraintrustServiceException- HTTP errors with a well-formed response body we were able to parse. The exception message and the.debuggingRequestId()will be set by the server.400 BadRequestException 401 AuthenticationException 403 PermissionDeniedException 404 NotFoundException 422 UnprocessableEntityException 429 RateLimitException 5xx InternalServerException others UnexpectedStatusCodeException -
BraintrustIoException- I/O networking errors -
BraintrustInvalidDataException- any other exceptions on the client side, e.g.:- We failed to serialize the request body
- We failed to parse the response body (has access to response code and body)
-
Requests that experience certain errors are automatically retried 2 times by default, with a short exponential backoff. Connection errors (for example, due to a network connectivity problem), 408 Request Timeout, 409 Conflict, 429 Rate Limit, and >=500 Internal errors will all be retried by default.
You can provide a maxRetries on the client builder to configure this:
val client = BraintrustOkHttpClient.builder()
.fromEnv()
.maxRetries(4)
.build()Requests time out after 1 minute by default. You can configure this on the client builder:
val client = BraintrustOkHttpClient.builder()
.fromEnv()
.timeout(Duration.ofSeconds(30))
.build()Requests can be routed through a proxy. You can configure this on the client builder:
val client = BraintrustOkHttpClient.builder()
.fromEnv()
.proxy(new Proxy(
Type.HTTP,
new InetSocketAddress("proxy.com", 8080)
))
.build()This package generally follows SemVer conventions, though certain backwards-incompatible changes may be released as minor versions:
- Changes to library internals which are technically public but not intended or documented for external use. (Please open a GitHub issue to let us know if you are relying on such internals).
- Changes that we do not expect to impact the vast majority of users in practice.
We take backwards-compatibility seriously and work hard to ensure you can rely on a smooth upgrade experience.
We are keen for your feedback; please open an issue with questions, bugs, or suggestions.
This library requires Java 8 or later.