@mastra/core
Version:
Mastra is a framework for building AI-powered applications and agents with a modern TypeScript stack.
64 lines (41 loc) • 1.98 kB
Markdown
# DatasetsManager.compareExperiments()
**Added in:** `@mastra/core@1.4.0`
Compares two or more experiments, producing per-item and per-scorer comparisons. Requires at least two experiment IDs.
## Usage example
```typescript
import { Mastra } from '@mastra/core'
const mastra = new Mastra({
/* storage config */
})
const comparison = await mastra.datasets.compareExperiments({
experimentIds: ['exp-baseline', 'exp-new'],
baselineId: 'exp-baseline',
})
console.log(`Baseline: ${comparison.baselineId}`)
for (const item of comparison.items) {
console.log(`Item ${item.itemId}:`)
console.log(` Input: ${JSON.stringify(item.input)}`)
for (const [expId, result] of Object.entries(item.results)) {
if (result) {
console.log(
` ${expId}: output=${JSON.stringify(result.output)}, scores=${JSON.stringify(result.scores)}`,
)
}
}
}
```
## Parameters
**experimentIds** (`string[]`): Array of experiment IDs to compare. Must contain at least 2.
**baselineId** (`string`): ID of the baseline experiment. Defaults to the first ID in \`experimentIds\`.
## Returns
Throws `MastraError` if fewer than 2 experiment IDs are provided.
**result** (`Promise<object>`): Comparison results.
**result.baselineId** (`string`): ID of the baseline experiment used for comparison.
**result.items** (`Array<object>`): Per-item comparison data.
**result.items.itemId** (`string`): ID of the dataset item.
**result.items.input** (`unknown | null`): Input data for the item.
**result.items.groundTruth** (`unknown | null`): Ground truth for the item.
**result.items.results** (`Record<string, { output: unknown; scores: Record<string, number | null> } | null>`): Results keyed by experiment ID. Each entry contains the output and scorer results for that experiment.
## Related
- [dataset.startExperiment()](https://mastra.ai/reference/datasets/startExperiment)
- [dataset.listExperiments()](https://mastra.ai/reference/datasets/listExperiments)