Package dev.dokimos.core.evaluators

Class RecallEvaluator.Builder

java.lang.Object
dev.dokimos.core.evaluators.RecallEvaluator.Builder
Enclosing class:
RecallEvaluator
public static class RecallEvaluator.Builder extends Object
Builder for constructing RecallEvaluator instances.

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • name

      public RecallEvaluator.Builder name(String name)
      Sets the evaluator name.
      Parameters:
      name - the evaluator name
      Returns:
      this builder

    • retrievedKey

      public RecallEvaluator.Builder retrievedKey(String retrievedKey)
      Sets the key for retrieved items in actualOutputs. Default is "retrieved".
      Parameters:
      retrievedKey - the key for retrieved items
      Returns:
      this builder

    • expectedKey

      public RecallEvaluator.Builder expectedKey(String expectedKey)
      Sets the key for expected (relevant) items in expectedOutputs. Default is "relevant".
      Parameters:
      expectedKey - the key for expected items
      Returns:
      this builder

    • threshold

      public RecallEvaluator.Builder threshold(double threshold)
      Sets the minimum score threshold for success. Default is 0.5.
      Parameters:
      threshold - the threshold value (0.0 to 1.0)
      Returns:
      this builder

    • matchingStrategy

      public RecallEvaluator.Builder matchingStrategy(MatchingStrategy matchingStrategy)
      Sets the strategy for matching retrieved items to expected items. Default is MatchingStrategy.byEquality().
      Parameters:
      matchingStrategy - the matching strategy
      Returns:
      this builder

    • evaluationParams

      public RecallEvaluator.Builder evaluationParams(List<EvalTestCaseParam> params)
      Sets which test case parameters to validate before evaluation.
      Parameters:
      params - the parameters to validate
      Returns:
      this builder

    • build

      public RecallEvaluator build()
      Builds the RecallEvaluator.
      Returns:
      a new RecallEvaluator instance