Constructor Detail

Method Detail

• experimentName

   final SummarizeExperimentResponse.Builder experimentName(String experimentName)

  Name of the experiment

• experimentName

   final SummarizeExperimentResponse.Builder experimentName(JsonField<String> experimentName)

  Sets Builder.experimentName to an arbitrary JSON value.

  You should usually call Builder.experimentName with a well-typed String value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• experimentUrl

   final SummarizeExperimentResponse.Builder experimentUrl(String experimentUrl)

  URL to the experiment's page in the Braintrust app

• experimentUrl

   final SummarizeExperimentResponse.Builder experimentUrl(JsonField<String> experimentUrl)

  Sets Builder.experimentUrl to an arbitrary JSON value.

  You should usually call Builder.experimentUrl with a well-typed String value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• projectName

   final SummarizeExperimentResponse.Builder projectName(String projectName)

  Name of the project that the experiment belongs to

• projectName

   final SummarizeExperimentResponse.Builder projectName(JsonField<String> projectName)

  Sets Builder.projectName to an arbitrary JSON value.

  You should usually call Builder.projectName with a well-typed String value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• projectUrl

   final SummarizeExperimentResponse.Builder projectUrl(String projectUrl)

  URL to the project's page in the Braintrust app

• projectUrl

   final SummarizeExperimentResponse.Builder projectUrl(JsonField<String> projectUrl)

  Sets Builder.projectUrl to an arbitrary JSON value.

  You should usually call Builder.projectUrl with a well-typed String value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• comparisonExperimentName

   final SummarizeExperimentResponse.Builder comparisonExperimentName(String comparisonExperimentName)

  The experiment which scores are baselined against

• comparisonExperimentName

   final SummarizeExperimentResponse.Builder comparisonExperimentName(Optional<String> comparisonExperimentName)

  Alias for calling Builder.comparisonExperimentName with comparisonExperimentName.orElse(null).

• comparisonExperimentName

   final SummarizeExperimentResponse.Builder comparisonExperimentName(JsonField<String> comparisonExperimentName)

  Sets Builder.comparisonExperimentName to an arbitrary JSON value.

  You should usually call Builder.comparisonExperimentName with a well-typed String value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• metrics

   final SummarizeExperimentResponse.Builder metrics(SummarizeExperimentResponse.Metrics metrics)

  Summary of the experiment's metrics

• metrics

   final SummarizeExperimentResponse.Builder metrics(Optional<SummarizeExperimentResponse.Metrics> metrics)

  Alias for calling Builder.metrics with metrics.orElse(null).

• metrics

   final SummarizeExperimentResponse.Builder metrics(JsonField<SummarizeExperimentResponse.Metrics> metrics)

  Sets Builder.metrics to an arbitrary JSON value.

  You should usually call Builder.metrics with a well-typed Metrics value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• scores

   final SummarizeExperimentResponse.Builder scores(SummarizeExperimentResponse.Scores scores)

  Summary of the experiment's scores

• scores

   final SummarizeExperimentResponse.Builder scores(Optional<SummarizeExperimentResponse.Scores> scores)

  Alias for calling Builder.scores with scores.orElse(null).

• scores

   final SummarizeExperimentResponse.Builder scores(JsonField<SummarizeExperimentResponse.Scores> scores)

  Sets Builder.scores to an arbitrary JSON value.

  You should usually call Builder.scores with a well-typed Scores value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• additionalProperties

   final SummarizeExperimentResponse.Builder additionalProperties(Map<String, JsonValue> additionalProperties)

• putAdditionalProperty

   final SummarizeExperimentResponse.Builder putAdditionalProperty(String key, JsonValue value)

• putAllAdditionalProperties

   final SummarizeExperimentResponse.Builder putAllAdditionalProperties(Map<String, JsonValue> additionalProperties)

• removeAdditionalProperty

   final SummarizeExperimentResponse.Builder removeAdditionalProperty(String key)

• removeAllAdditionalProperties

   final SummarizeExperimentResponse.Builder removeAllAdditionalProperties(Set<String> keys)

• build

   final SummarizeExperimentResponse build()

  Returns an immutable instance of SummarizeExperimentResponse.

  Further updates to this Builder will not mutate the returned instance.

  The following fields are required:

  .experimentName()
  .experimentUrl()
  .projectName()
  .projectUrl()