Get a dataset summary

2 parameters

dataset_idstringrequired

The UUID of the dataset to summarize.

summarize_databooleanoptional

Whether to include a summary of the dataset's data. Defaults to false when omitted.

6 status codes

200Returns a dataset summary containing the project name, dataset name, project URL, and dataset URL. When `summarize_data` is true, the response can also include `data_summary` with the total record count.

project_namestringrequired

Name of the project that the dataset belongs to

dataset_namestringrequired

Name of the dataset

project_urlstringrequired

URL to the project's page in the Braintrust app

dataset_urlstringrequired

URL to the dataset's page in the Braintrust app

data_summaryobjectoptional

Summary of a dataset's data

400Returned when the request is unacceptable, such as when `dataset_id` is missing or invalid.

401Returned when no valid API key is provided.

403Returned when the API key does not have permission to summarize the dataset.

429Returned when too many requests reach the API too quickly.

500Returned when an unexpected failure occurs on the API side.

Error handling

A 400 is returned when the request is unacceptable, such as when dataset_id is missing or invalid. A 401 is returned without a valid API key, and a 403 is returned when the API key lacks permission. A 429 indicates that requests are being sent too quickly, while a 500 indicates an API-side failure.

import { Client } from "acme-sdk";

const client = new Client({
  baseUrl: "https://api.acme.com",
});

const result = await client.summarize.list({
  datasetId: "c0a80123-4567-89ab-cdef-0123456789ab",
  summarizeData: "example",
});

{
  "project_name": "Example Name",
  "dataset_name": "Example Name",
  "project_url": "https://example.com",
  "dataset_url": "https://example.com",
  "data_summary": {
    "total_records": 42
  }
}

Request

Response

Errors