BRbraintrustdata
Experiments

Summarize experiment

Changed on

Return the experiment and project names and URLs. Set summarize_scores=true to include aggregate scores and metrics, with differences, improvements, and regressions relative to a comparison experiment. Use comparison_experiment_id to select the comparison; otherwise, the experiment's base experiment or the most recent experiment in the project is used.

get/v1/experiment/{experiment_id}/summarize

Request

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

Path parameters

experiment_idstring uuid required

Experiment id

Query parameters

summarize_scoresboolean nullable

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

comparison_experiment_idstring uuid

The experiment to compare against, if summarizing scores and metrics. If omitted, will fall back to the base_exp_id stored in the experiment metadata, and then to the most recent experiment run in the same project. Must pass summarize_scores=true for this id to be used

Response

Experiment summary

project_namestring required

Name of the project that the experiment belongs to

experiment_namestring required

Name of the experiment

project_urlstring uri required

URL to the project's page in the Braintrust app

experiment_urlstring uri required

URL to the experiment's page in the Braintrust app

comparison_experiment_namestring nullable

The experiment which scores are baselined against

scoresobject nullable

Summary of the experiment's scores

metricsobject nullable

Summary of the experiment's metrics

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