Sign in

v47

latestOpenAPI 3.0.3Apache 2.0raw.githubusercontent.com2024-10-01163166522.3 KB
Experiments

Summarize experiment

Summarize experiment

get/v1/experiment/{experiment_id}/summarize

Path parameters

experiment_idstring uuid required

Experiment id

Experiment id

Query parameters

summarize_scoresboolean nullable

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

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

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