Docs
Reference
Release notes

Release notes

Week of 2024-04-22

  • Fix a race condition in distributed tracing, in which subspans could hit the backend before their parent span, resulting in an inaccurate trace structure.
‼️

As part of this change, we removed the parent_id argument from the latest SDK, which was previously deprecated in favor of parent. parent_id is only able to use the race-condition-prone form of distributed tracing, so we felt it would be best for folks to upgrade any of their usages from parent_id to parent. Before upgrading your SDK, if you are currently using parent_id, you can port over to using parent by changing any exported IDs from span.id to span.export() and then changing any instances of parent_id=[span_id] to parent=[exported_span].

For example, if you had distributed tracing code like the following:

import { initLogger } from "braintrust";
 
const logger = initLogger({
  projectName: "My Project",
  apiKey: process.env.BRAINTRUST_API_KEY,
});
 
export async function POST(req: Request) {
  return logger.traced(async (span) => {
    const { body } = req;
    const result = await someLLMFunction(body);
    span.log({ input: body, output: result });
    return {
      result,
      requestId: span.id,
    };
  });
}
 
export async function POSTFeedback(req: Request) {
  logger.traced(
    async (span) => {
      logger.logFeedback({
        id: span.id, // Use the newly created span's id, instead of the original request's id
        comment: req.body.comment,
        scores: {
          correctness: req.body.score,
        },
        metadata: {
          user_id: req.user.id,
        },
      });
    },
    {
      parentId: req.body.requestId,
      name: "feedback",
    }
  );
}

It would now look like this:

import { initLogger } from "braintrust";
 
const logger = initLogger({
  projectName: "My Project",
  apiKey: process.env.BRAINTRUST_API_KEY,
});
 
export async function POST(req: Request) {
  return logger.traced(async (span) => {
    const { body } = req;
    const result = await someLLMFunction(body);
    span.log({ input: body, output: result });
    return {
      result,
      requestId: span.export(),
    };
  });
}
 
export async function POSTFeedback(req: Request) {
  logger.traced(
    async (span) => {
      logger.logFeedback({
        id: span.id, // Use the newly created span's id, instead of the original request's id
        comment: req.body.comment,
        scores: {
          correctness: req.body.score,
        },
        metadata: {
          user_id: req.user.id,
        },
      });
    },
    {
      parent_id: req.body.requestId,
      name: "feedback",
    }
  );
}

Week of 2024-04-15

  • Incremental support for roles-based access control (RBAC) logic within the API server backend.
‼️

As part of this change, we removed certain API endpoints which are no longer in use. In particular, the /crud/{object_type} endpoint. For the handful of usages of these endpoints in old versions of the SDK libraries, we added backwards-compatibility routes, but it is possible we may have missed a few. Please let us know if your code is trying to use an endpoint that no longer exists and we can remediate.

  • Changed the semantics of experiment initialization with update=True. Previously, we would require the experiment to already exist, now we will create the experiment if it doesn't already exist otherwise return the existing one.
‼️

This change affects the semantics of the PUT /v1/experiment operation, so that it will not replace the contents of an existing experiment with a new one, but instead just return the existing one, meaning it behaves the same as POST /v1/experiment. Eventually we plan to revise the update semantics for other object types as well. Therefore, we have deprecated the PUT endpoint across the board and plan to remove it in a future revision of the API.

Week of 2024-04-08

  • Added support for new multimodal models (gpt-4-turbo, gpt-4-vision-preview, gpt-4-1106-vision-preview, gpt-4-turbo-2024-04-09, claude-3-opus-20240229, claude-3-sonnet-20240229, claude-3-haiku-20240307).
  • Introduced REST API for RBAC (Role-Based Access Control) objects including CRUD operations on roles, groups, and permissions, and added a read-only API for users.
  • Improved AI search and added positive/negative tag filtering in AI search. To positively filter, prefix the tag with +, and to negatively filter, prefix the tag with -.
‼️

We are making some systematic changes to the search experience, and the search syntax is subject to change.

Week of 2024-04-01

  • Added functionality for distributed tracing. See the docs for more details.
‼️

As part of this change, we had to rework the core logging implementation in the SDKs to rely on some newer backend API features. Therefore, if you are hosting Braintrust on-prem, before upgrading your SDK to any version >= 0.0.115, make sure your API version is >= 0.0.35. You can query the version of the on-prem server with curl [api-url]/version, where the API URL can be found on the settings page.

Week of 2024-03-25

  • Introduce multimodal support for OpenAI and Anthropic models in the prompt playground and proxy. You can now pass image URLs, base64-encoded image strings, or mustache template variables to models that support multimodal inputs. Multimodal prompt
  • The REST API now gzips responses.
  • You can now return dynamic arrays of scores in Eval() functions (docs).
  • Launched Reporters, a way to summarize and report eval results in a custom format.
  • New coat of paint in the trace view.
  • Added support for Clickhouse as an additional storage backend, offering a more scalable solution for handling large datasets and performance improvements for certain query types. You can enable it by setting the UseManagedClickhouse parameter to true in the CloudFormation template or installing the docker container.
  • Implemented realtime checks using a WebSocket connection and updated proxy configurations to include CORS support.
  • Introduced an API version checker tool so you know when your API version is outdated.

Week of 2024-03-18

  • Add new database parameters for external databases in the CloudFormation template.
  • Faster optimistic updates for large writes in the UI.
  • "Open in playground" now opens a lighter weight modal instead of the full playground.
  • Can create a new prompt playground from the prompt viewer.

Week of 2024-03-11

  • Shipped support for prompt management.
  • Moved playground sessions to be within projects. All existing sessions are now in the "Playground Sessions" project.
  • Allowed customizing proxy and real-time URLs through the web application, adding flexibility for different deployment scenarios.
  • Improved documentation for Docker deployments.
  • Improved folding behavior in data editors.

Week of 2024-03-04

  • Support custom models and endpoint configuration for all providers.
  • New add team modal with support for multiple users.
  • New information architecture to enable faster project navigation.
  • Experiment metadata now visible in the experiments table.
  • Improve UI write performance with batching.
  • Log filters now apply to any span.
  • Share button for traces
  • Images now supported in the tree view (see tracing docs for more).

Week of 2024-02-26

  • Show auto scores before manual scores (matching trace) in the table
  • New logo is live!
  • Any span can now submit scores, which automatically average in the trace. This makes it easier to label scores in the spans where they originate.
  • Improve sidebar scrolling behavior.
  • Add AI search for datasets and logs.
  • Add tags to the SDK.
  • Support viewing and updating metadata on the experiment page.

Week of 2024-02-19

‼️

We rolled out a breaking change to the REST API that renames the output field to expected on dataset records. This change brings the API in line with last week's update to the Braintrust SDK. For more information, refer to the REST API docs for dataset records (insert and fetch).

  • Add support for tags.
  • Score fields are now sorted alphabetically.
  • Add support for Groq ModuleResolutionKind.
  • Improve tree viewer and XML parser.
  • New experiment page redesign

Week of 2024-02-12

‼️

We are rolling out a change to dataset records that renames the output field to expected. If you are using the SDK, datasets will still fetch records using the old format for now, but we recommend future-proofing your code by setting the useOutput / use_output flag to false when calling initDataset() / init_dataset(), which will become the default in a future version of Braintrust.

When you set useOutput to false, your dataset records will contain expected instead of output. This makes it easy to use them with Eval(...) to provide expected outputs for scoring, since you'll no longer have to manually rename output to expected when passing data to the evaluator:

import { Eval, initDataset } from "braintrust";
import { Levenshtein } from "autoevals";
 
Eval("My Eval", {
  data: initDataset("Existing Dataset", { useOutput: false }), // Records will contain `expected` instead of `output`
  task: (input) => "foo",
  scores: [Levenshtein],
});

Here's an example of how to insert and fetch dataset records using the new format:

import { initDataset } from "braintrust";
 
// Currently `useOutput` defaults to true, but this will change in a future version of Braintrust.
const dataset = initDataset("My Dataset", { useOutput: false });
 
dataset.insert({
  input: "foo",
  expected: { result: 42, error: null }, // Instead of `output`
  metadata: { model: "gpt-3.5-turbo" },
});
await dataset.flush();
 
for await (const record of dataset) {
  console.log(record.expected); // Instead of `record.output`
}
  • Support duplicate Eval names.
  • Fallback to BRAINTRUST_API_KEY if OPENAI_API_KEY is not set.
  • Throw an error if you use experiment.log and experiment.start_span together.
  • Add keyboard shortcuts (j/k/p/n) for navigation.
  • Increased tooltip size and delay for better usability.
  • Support more viewing modes: HTML, Markdown, and Text.

Week of 2024-02-05

Playground

  • Tons of improvements to the prompt playground:
    • A new "compact" view, that shows just one line per row, so you can quickly scan across rows. You can toggle between the two modes.
    • Loading indicators per cell
    • The run button transforms into a "Stop" button while you are streaming data
    • Prompt variables are now syntax highlighted in purple and use a monospace font
    • Tab now autocompletes
    • We no longer auto-create variables as you're typing (was causing more trouble than helping)
    • Slider params like max_tokens are now optional
  • Cloudformation now supports more granular RDS configuration (instance type, storage, etc)
  • Support optional slider params
  • Lots of style improvements for tables.
    • Fixed filter bar styles.
    • Rendered JSON cell values using monospace type.
    • Adjusted margins for horizontally scrollable tables.
    • Implemented a smaller size for avatars in tables.
  • Deleting a prompt takes you back to the prompts tab

Week of 2024-01-29

  • New REST API.
  • Cookbook of common use cases and examples.
  • Support for custom models in the playground.
  • Search now works across spans, not just top-level traces.
  • Show creator avatars in the prompt playground
  • Improved UI breadcrumbs and sticky table headers

Week of 2024-01-22

  • UI improvements to the playground.
  • Added an example of closed QA / extra fields.
  • New YAML parser and new syntax highlighting colors for data editor.
  • Added support for enabling/disabling certain git fields from collection (in org settings and the SDK).
  • Added new GPT-3.5 and 4 models to the playground.
  • Fixed scrolling jitter issue in the playground.
  • Made table fields in the prompt playground sticky.

Week of 2024-01-15

  • Added ability to download dataset as CSV
  • Added YAML support for logging and visualizing traces
  • Added JSON mode in the playground
  • Added span icons and improved readability
  • Enabled shift modifier for selecting multiple rows in Tables
  • Improved tables to allow editing expected fields and moved datasets to trace view

Week of 2024-01-08

Week of 2024-01-01

Week of 2023-12-25

  • API keys are now scoped to organizations, so if you are part of multiple orgs, new API keys will only permit access to the org they belong to.
  • You can now search for experiments by any metadata, including their name, author, or even git metadata.
  • Filters are now saved in URL state so you can share a link to a filtered view of your experiments or logs.
  • Improve performance of project page by optimizing API calls.
‼️

We made several cleanups and improvements to the low-level typescript and python SDKs (0.0.86). If you use the Eval framework, nothing should change for you, but keep in mind the following differences if you use the manual logging functionality:

  • Simplified the low-level tracing API (updated docs coming soon!)
    • The current experiment and current logger are now maintained globally rather than as async-task-local variables. This makes it much simpler to start tracing with minimal code modification. Note that creating experiments/loggers with withExperiment/withLogger will now set the current experiment globally (visible across all async tasks) rather than local to a specific task. You may pass setCurrent: false/set_current=False to avoid setting the global current experiment/logger.
    • In python, the @traced decorator now logs the function input/output by default. This might interfere with code that already logs input/output inside the traced function. You may pass notrace_io=True as an argument to @traced to turn this logging off.
    • In typescript, the traced method can start spans under the global logger, and is thus async by default. You may pass asyncFlush: true to these functions to make the traced function synchronous. Note that if the function tries to trace under the global logger, it must also have asyncFlush: true.
    • Removed the withCurrent/with_current functions
    • In typescript, the Span.traced method now accepts name as an optional argument instead of a required positional param. This matches the behavior of all other instances of traced. name is also now optional in python, but this doesn't change the function signature.
  • Experiments and Datasets are now lazily-initialized, similar to Loggers. This means all write operations are immediate and synchronous. But any metadata accessor methods ([Experiment|Logger].[id|name|project]) are now async.
  • Undo auto-inference of force_login if login is invoked with different params than last time. Now login will only re-login if forceLogin: true/force_login=True is provided.

Week of 2023-12-18

  • Dropped the official 2023 Year-in-Review dashboard. Check out yours here!

2023 year in review

  • Improved ergonomics for the Python SDK:
    • The @traced decorator will automatically log inputs/outputs
    • You no longer need to use context managers to scope experiments or loggers.
  • Enable skew protection in frontend deploys, so hopefully no more hard refreshes.
  • Added syntax highlighting in the sidepanel to improve readability.
  • Add jsonl mode to the eval CLI to log experiment summaries in an easy-to-parse format.

Week of 2023-12-11

  • Released new trials feature to rerun each input multiple times and collect aggregate results for a more robust score.
  • Added ability to run evals in the prompt playground. Use your existing dataset and the autoevals functions to score playground outputs.
  • Released new version of SDK (0.0.81) including a small breaking change. When setting the experiment name in the Eval function, the exprimentName key pair should be moved to a top level argument. before:
Eval([eval_name], {
  ...,
  metadata: {
    experimentName: [experimentName]
  }
})

after:

Eval([eval_name], {
  ...,
  experimentName: [experimentName]
})
  • Added support for Gemini and Mistral Platform in AI proxy and playground

Week of 2023-12-4

  • Enabled the prompt playground and datasets for free users
  • Added Together.ai models including Mixtral to AI Proxy
  • Turned prompts tab on organization view into a list
  • Removed data row limit for the prompt playground
  • Enabled configuration for dark mode and light mode in settings
  • Added automatic logging of a diff if an experiment is run on a repo with uncommitted changes

Week of 2023-11-27

  • Added experiment search on project view to filter by experiment name

    Experiment search and filtering on project view

  • Upgraded AI Proxy to support tracking Prometheus metrics
  • Modified Autoevals library to use the AI proxy
  • Upgraded Python braintrust library to parallelize evals
  • Optimized experiment diff view for performance improvements

Week of 2023-11-20

  • Added support for new Perplexity models (ex: pplx-7b-online) to playground
  • Released AI proxy: access many LLMs using one API w/ caching
  • Added load balancing endpoints to AI proxy
  • Updated org-level view to show projects and prompt playground sessions
  • Added ability to batch delete experiments
  • Added support for Claude 2.1 in playground

Week of 2023-11-13

  • Made experiment column resized widths persistent
  • Fixed our libraries including Autoevals to work with OpenAI’s new libraries

    Added OpenAI function calling in the prompt playground

  • Added support for function calling and tools in our prompt playground
  • Added tabs on a project page for datasets, experiments, etc.

Week of 2023-11-06

  • Improved selectors for diffing and comparison modes on experiment view
  • Added support for new OpenAI models (GPT4 preview, 3.5turbo-1106) in playground
  • Added support for OS models (Mistral, Codellama, Llama2, etc.) in playground using Perplexity's APIs

Week of 2023-10-30

  • Improved experiment sidebar to be fully responsive and resizable
  • Improved tooltips within the web UI
  • Multiple performance optimizations and bug fixes

Week of 2023-10-23

ReleaseNotes-2023-10-dataset.png

  • Multiple performance optimizations and bug fixes

Week of 2023-10-16

  • Launched new tracing feature: log and visualize complex LLM chains and executions.
  • Added a new “text-block” prompt type in the playground that just returns a string or variable back without a LLM call (useful for chaining prompts and debugging)
  • Increased default # of rows per page from 10 to 100 for experiments
  • UI fixes and improvements for the side panel and tooltips
  • The experiment dashboard can be customized to show the most relevant charts

Week of 2023-10-09

  • Performance improvements related to user sessions

Week of 2023-10-02

  • All experiment loading HTTP requests are 100-200ms faster
  • The prompt playground now supports autocomplete
  • Dataset versions are now displayed on the datasets page

ReleaseNotes-2023-10-dataset.png

Week of 2023-09-18

  • The Eval framework is now supported in Python! See the updated evals guide for more information:
from braintrust import Eval
from autoevals import LevenshteinScorer
 
Eval(
  "Say Hi Bot",
  data=lambda: [
      {
          "input": "Foo",
          "expected": "Hi Foo",
      },
      {
          "input": "Bar",
          "expected": "Hello Bar",
      },
  ],  # Replace with your eval dataset
  task=lambda input: "Hi " + input,  # Replace with your LLM call
  scores=[LevenshteinScorer],
)
  • Onboarding and signup flow for new users
  • Switch product font to Inter

Week of 2023-09-11

  • Big performance improvements for registering experiments (down from ~5s to <1s). Update the SDK to take advantage of these improvements.

  • New graph shows aggregate accuracy between experiments for each score.

    Score Comparison Chart

  • Throw errors in the prompt playground if you reference an invalid variable.

  • A significant backend database change which significantly improves performance while reducing costs. Please contact us if you have not already heard from us about upgrading your deployment.

  • No more record size constraints (previously, strings could be at most 64kb long).

  • New autoevals for numeric diff and JSON diff

Week of 2023-09-05

  • You can duplicate prompt sessions, prompts, and dataset rows in the prompt playground.
  • You can download prompt sessions as JSON files (including the prompt templates, prompts, and completions).
  • You can adjust model parameters (e.g. temperature) in the prompt playground.
  • You can publicly share experiments (e.g. Alpaca Evals).
  • Datasets now support editing, deleting, adding, and copying rows in the UI.
  • There is no longer a 64KB limit on strings.

Week of 2023-08-28

  • The prompt playground is now live! We're excited to get your feedback as we continue to build this feature out. See the docs for more information.

Sync Playground

Week of 2023-08-21

  • A new chart shows experiment progress per score over time.

Experiment Progress

  • The eval CLI now supports --watch, which will automatically re-run your evaluation when you make changes to your code.
  • You can now edit datasets in the UI.

Edit Dataset

Week of 2023-08-14

  • Introducing datasets! You can now upload datasets to Braintrust and use them in your experiments. Datasets are versioned, and you can use them in multiple experiments. You can also use datasets to compare your model's performance against a baseline. Learn more about how to create and use datasets in the docs.
  • Fix several performance issues in the SDK and UI.

Week of 2023-08-07

  • Complex data is now substantially more performant in the UI. Prior to this change, we ran schema inference over the entire input, output, expected, and metadata fields, which could result in complex structures that were slow and difficult to work with. Now, we simply treat these fields as JSON types.
  • The UI updates in real-time as new records are logged to experiments.
  • Ergonomic improvements to the SDK and CLI:
    • The JS library is now Isomorphic and supports both Node.js and the browser.
    • The Evals CLI warns you when no files match the .eval.[ts|js] pattern.

Week of 2023-07-31

  • You can now break down scores by metadata fields:

Grouped Score Chart

  • Improve performance for experiment loading (especially complex experiments). Prior to this change, you may have seen experiments take 30s+ occasionally or even fail. To enable this, you'll need to update your CloudFormation.

  • Support for renaming and deleting experiments:

Rename Delete Menu

  • When you expand a cell in detail view, the row is now highlighted:

Highlight Row

Week of 2023-07-24

  • A new framework for expressing evaluations in a much simpler way:
import { Eval } from "braintrust";
import { Factuality } from "autoevals";
 
Eval("My Evaluation", {
  data: () => [
    {
      input: "Which country has the highest population?",
      expected: "China",
      meta: { type: "question" },
    },
  ],
  task: (input) => callModel(input),
  scores: [Factuality],
});

Besides being much easier than the logging SDK, this framework sets the foundation for evaluations that can be run automatically as your code changes, built and run in the cloud, and more. We are very excited about the use cases it will open up!

  • inputs is now input in the SDK (>= 0.0.23) and UI. You do not need to make any code changes, although you should gradually start using the input field instead of inputs in your SDK calls, as inputs is now deprecated and will eventually be removed.
  • Improved diffing behavior for nested arrays.

Week of 2023-07-17

  • A couple of SDK updates (>= v0.0.21) that allow you to update an existing experiment init(..., update=True) and specify an id in log(..., id='my-custom-id'). These tools are useful for running an experiment across multiple processes, tasks, or machines, and idempotently logging the same record (identified by its id).
  • Tables with lots and lots of columns are now visually more compact in the UI:

Before:

Table before

After:

Table after

Week of 2023-07-10

  • A new Node.js SDK (npm) which mirrors the Python SDK. As this SDK is new, please let us know if you run into any issues or have any feedback.
‼️

If you have Braintrust installed in your own cloud environment, make sure to update the CloudFormation (available at https://braintrust-cf.s3.amazonaws.com/braintrust-latest.yaml) to include some functionality the Node.js SDK relies on.

You can do this in the AWS console, or by running the following command (with the braintrust command included in the Python SDK).

braintrust install api <YOUR_CLOUDFORMAT_STACK_NAME> --update-template
  • You can now swap the primary and comparison experiment with a single click.

Swap experiments

  • You can now compare output vs. expected within an experiment.

Diff output and expected

  • Version 0.0.19 is out for the SDK. It is an important update that throws an error if your payload is larger than 64KB in size.

Week of 2023-07-03

  • Support for real-time updates, using Redis. Prior to this, Braintrust would wait for your data warehouse to sync up with Kafka before you could view an experiment, often leading to a minute or two of time before a page loads. Now, we cache experiment records as your experiment is running, making experiments load instantly. To enable this, you'll need to update your CloudFormation.

  • New settings page that consolidates team, installation, and API key settings. You can now invite team members to your Braintrust account from the "Team" page.

    Settings Page

  • The experiment page now shows commit information for experiments run inside of a git repository.

    Git info

Week of 2023-06-26

  • Experiments track their git metadata and automatically find a "base" experiment to compare against, using your repository's base branch.
  • The Python SDK's summarize() method now returns an ExperimentSummary object with score differences against the base experiment (v0.0.10).
  • Organizations can now be "multi-tenant", i.e. you do not need to install in your cloud account. If you start with a multi-tenant account to try out Braintrust, and decide to move it into your own account, Braintrust can migrate it for you.

Week of 2023-06-19

Week of 2023-06-12

  • New braintrust install CLI for installing the CloudFormation
  • Improved performance for event logging in the SDK
  • Auto-merge experiment fields with different types (e.g. number and string)

Week of 2023-06-05

  • Tutorial guide + notebook

  • Automatically refresh cognito tokens in the Python client

  • New filter and sort operators on the experiments table:

    • Filter experiments by changes to scores (e.g. only examples with a lower score than another experiment)
    • Custom SQL filters
    • Filter and sort bubbles to visualize/clear current operations
  • [Alpha] SQL query explorer to run arbitrary queries against one or more experiments


    SQL Explorer