Interface EvaluationDimension.Builder

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

  • Method Details

    • dimensionName

      EvaluationDimension.Builder dimensionName(String dimensionName)

      The name of the dimension. This name is unique within the evaluator and identifies the dimension's results.

      Parameters:
      dimensionName - The name of the dimension. This name is unique within the evaluator and identifies the dimension's results.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • dimensionInstruction

      EvaluationDimension.Builder dimensionInstruction(String dimensionInstruction)

      The instruction to the evaluator model for this dimension, describing what the model should judge when scoring the dimension.

      Parameters:
      dimensionInstruction - The instruction to the evaluator model for this dimension, describing what the model should judge when scoring the dimension.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • dimensionRatingScale

      EvaluationDimension.Builder dimensionRatingScale(DimensionRatingScale dimensionRatingScale)

      The rating scale for this dimension, which can be numerical or categorical. A dimension's rating scale cannot itself be multi-dimensional.

      Parameters:
      dimensionRatingScale - The rating scale for this dimension, which can be numerical or categorical. A dimension's rating scale cannot itself be multi-dimensional.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • dimensionRatingScale

      default EvaluationDimension.Builder dimensionRatingScale(Consumer<DimensionRatingScale.Builder> dimensionRatingScale)

      The rating scale for this dimension, which can be numerical or categorical. A dimension's rating scale cannot itself be multi-dimensional.

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

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to dimensionRatingScale(DimensionRatingScale).

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