Package com.braintrustdata.api.models
Class ExperimentSummarizeParams
-
- All Implemented Interfaces:
-
com.braintrustdata.api.core.Params
public final class ExperimentSummarizeParams implements Params
Summarize experiment
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final classExperimentSummarizeParams.BuilderA builder for ExperimentSummarizeParams.
-
Method Summary
Modifier and Type Method Description final StringexperimentId()Experiment id final Optional<String>comparisonExperimentId()The experiment to compare against, if summarizing scores and metrics. final Optional<Boolean>summarizeScores()Whether to summarize the scores and metrics. final Headers_additionalHeaders()final QueryParams_additionalQueryParams()final ExperimentSummarizeParams.BuildertoBuilder()final String_pathParam(Integer index)Headers_headers()The full set of headers in the parameters, including both fixed and additional headers. QueryParams_queryParams()The full set of query params in the parameters, including both fixed and additional query params. Booleanequals(Object other)IntegerhashCode()StringtoString()final static ExperimentSummarizeParams.Builderbuilder()Returns a mutable builder for constructing an instance of ExperimentSummarizeParams. -
-
Method Detail
-
experimentId
final String experimentId()
Experiment id
-
comparisonExperimentId
final Optional<String> comparisonExperimentId()
The experiment to compare against, if summarizing scores and metrics. If omitted, will fall back to the
base_exp_idstored in the experiment metadata, and then to the most recent experiment run in the same project. Must passsummarize_scores=truefor this id to be used
-
summarizeScores
final Optional<Boolean> summarizeScores()
Whether to summarize the scores and metrics. If false (or omitted), only the metadata will be returned.
-
_additionalHeaders
final Headers _additionalHeaders()
-
_additionalQueryParams
final QueryParams _additionalQueryParams()
-
toBuilder
final ExperimentSummarizeParams.Builder toBuilder()
-
_pathParam
final String _pathParam(Integer index)
-
_headers
Headers _headers()
The full set of headers in the parameters, including both fixed and additional headers.
-
_queryParams
QueryParams _queryParams()
The full set of query params in the parameters, including both fixed and additional query params.
-
builder
final static ExperimentSummarizeParams.Builder builder()
Returns a mutable builder for constructing an instance of ExperimentSummarizeParams.
The following fields are required:
.experimentId()
-
-
-
-