Interface CustomMetricDefinition.Builder

All Superinterfaces:
Buildable, CopyableBuilder<CustomMetricDefinition.Builder,CustomMetricDefinition>, SdkBuilder<CustomMetricDefinition.Builder,CustomMetricDefinition>, SdkPojo
Enclosing class:
CustomMetricDefinition
@Mutable @NotThreadSafe public static interface CustomMetricDefinition.Builder extends SdkPojo, CopyableBuilder<CustomMetricDefinition.Builder,CustomMetricDefinition>

  • Method Details

    • name

      CustomMetricDefinition.Builder name(String name)

      The name for a custom metric. Names must be unique in your Amazon Web Services region.

      Parameters:
      name - The name for a custom metric. Names must be unique in your Amazon Web Services region.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • instructions

      CustomMetricDefinition.Builder instructions(String instructions)

      The prompt for a custom metric that instructs the evaluator model how to rate the model or RAG source under evaluation.

      Parameters:
      instructions - The prompt for a custom metric that instructs the evaluator model how to rate the model or RAG source under evaluation.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • ratingScale

      CustomMetricDefinition.Builder ratingScale(Collection<RatingScaleItem> ratingScale)

      Defines the rating scale to be used for a custom metric. We recommend that you always define a ratings scale when creating a custom metric. If you don't define a scale, Amazon Bedrock won't be able to visually display the results of the evaluation in the console or calculate average values of numerical scores. For more information on specifying a rating scale, see Specifying an output schema (rating scale).

      Parameters:
      ratingScale - Defines the rating scale to be used for a custom metric. We recommend that you always define a ratings scale when creating a custom metric. If you don't define a scale, Amazon Bedrock won't be able to visually display the results of the evaluation in the console or calculate average values of numerical scores. For more information on specifying a rating scale, see Specifying an output schema (rating scale).
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • ratingScale

      CustomMetricDefinition.Builder ratingScale(RatingScaleItem... ratingScale)

      Defines the rating scale to be used for a custom metric. We recommend that you always define a ratings scale when creating a custom metric. If you don't define a scale, Amazon Bedrock won't be able to visually display the results of the evaluation in the console or calculate average values of numerical scores. For more information on specifying a rating scale, see Specifying an output schema (rating scale).

      Parameters:
      ratingScale - Defines the rating scale to be used for a custom metric. We recommend that you always define a ratings scale when creating a custom metric. If you don't define a scale, Amazon Bedrock won't be able to visually display the results of the evaluation in the console or calculate average values of numerical scores. For more information on specifying a rating scale, see Specifying an output schema (rating scale).
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • ratingScale

      CustomMetricDefinition.Builder ratingScale(Consumer<RatingScaleItem.Builder>... ratingScale)

      Defines the rating scale to be used for a custom metric. We recommend that you always define a ratings scale when creating a custom metric. If you don't define a scale, Amazon Bedrock won't be able to visually display the results of the evaluation in the console or calculate average values of numerical scores. For more information on specifying a rating scale, see Specifying an output schema (rating scale).

      This is a convenience method that creates an instance of the RatingScaleItem.Builder avoiding the need to create one manually via RatingScaleItem.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to ratingScale(List<RatingScaleItem>).

      Parameters:
      ratingScale - a consumer that will call methods on RatingScaleItem.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also: