BRbraintrustdata
Datasets

Summarize dataset

Changed on

Return the dataset and project names and URLs. Set summarize_data=true to include the total number of records in the dataset; otherwise, only metadata is returned.

get/v1/dataset/{dataset_id}/summarize

Request

  • Base URL
    https://api.braintrust.dev
  • Auth
    HTTP bearer

Path parameters

dataset_idstring uuid required

Dataset id

Query parameters

summarize_databoolean nullable

Whether to summarize the data. If false (or omitted), only the metadata will be returned.

Response

Dataset summary

project_namestring required

Name of the project that the dataset belongs to

dataset_namestring required

Name of the dataset

project_urlstring uri required

URL to the project's page in the Braintrust app

dataset_urlstring uri required

URL to the dataset's page in the Braintrust app

Changes

  • ac2727014d93Revision changes
    • breaking

      the response's body became nullable

    • breaking

      the response's body became nullable

    • breaking

      the response's body became nullable

    • breaking

      the response's body became nullable

    • breaking

      the response's body became nullable

  • 44b51ad3239aRevision changes
    • info

      endpoint added