Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
69 changes: 69 additions & 0 deletions .changeset/goofy-hotels-care.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,69 @@
---
"braintrust": minor
---

Add dataset versioning support to `init()`, `initDataset()`, and dataset objects.

You can now pin dataset reads and experiment registration by explicit version, snapshot name, or environment tag:

```ts
import { init, initDataset } from "braintrust";

const datasetByVersion = initDataset({
project: "support-bot",
dataset: "production-cases",
version: "1234567890123456",
});

const datasetBySnapshot = initDataset({
project: "support-bot",
dataset: "production-cases",
snapshotName: "baseline",
});

const datasetByEnvironment = initDataset({
project: "support-bot",
dataset: "production-cases",
environment: "production",
});

init({
project: "support-bot",
experiment: "baseline-eval",
dataset: {
id: "00000000-0000-0000-0000-000000000123",
snapshotName: "baseline",
},
});
```

Dataset objects now expose snapshot CRUD helpers, plus lookup by snapshot name or xact id:

```ts
const dataset = initDataset({
project: "support-bot",
dataset: "production-cases",
});

const snapshot = await dataset.createSnapshot({
name: "baseline",
description: "Before the prompt rollout",
});

await dataset.updateSnapshot(snapshot.id, {
name: "baseline-v2",
description: null,
});

const snapshots = await dataset.listSnapshots();
const byName = await dataset.getSnapshot({
snapshotName: "baseline-v2",
});
const byXactId = await dataset.getSnapshot({
xactId: snapshot.xact_id,
});

await dataset.deleteSnapshot(snapshot.id);
```

`braintrust/dev` now also respects `dataset_version` and `dataset_environment` when resolving datasets for evals, so local eval runs match the pinned dataset selection used by the main SDK.
4 changes: 4 additions & 0 deletions js/dev/server.ts
Original file line number Diff line number Diff line change
Expand Up @@ -318,6 +318,8 @@ async function getDataset(
state,
project: data.project_name,
dataset: data.dataset_name,
version: data.dataset_version ?? undefined,
environment: data.dataset_environment ?? undefined,
_internal_btql: data._internal_btql ?? undefined,
});
} else if ("dataset_id" in data) {
Expand All @@ -329,6 +331,8 @@ async function getDataset(
state,
projectId: datasetInfo.projectId,
dataset: datasetInfo.dataset,
version: data.dataset_version ?? undefined,
environment: data.dataset_environment ?? undefined,
_internal_btql: data._internal_btql ?? undefined,
});
} else {
Expand Down
3 changes: 3 additions & 0 deletions js/src/exports.ts
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,9 @@ export type {
CompiledPromptParams,
CompletionPrompt,
ContextParentSpanIds,
DatasetRestorePreviewResult,
DatasetRestoreResult,
DatasetSnapshot,
DataSummary,
DatasetSummary,
DefaultMetadataType,
Expand Down
Loading
Loading