Package org.codelibs.fess.llm

Class RelevanceEvaluationResult

java.lang.Object
org.codelibs.fess.llm.RelevanceEvaluationResult
public class RelevanceEvaluationResult extends Object
Result of relevance evaluation for search results.

  • Method Details

    • getRelevantDocIds

      public List<String> getRelevantDocIds()
      Returns the list of relevant document IDs.
      Returns:
      the relevant document IDs

    • getRelevantIndexes

      public List<Integer> getRelevantIndexes()
      Returns the list of relevant indexes (1-based) from search results.
      Returns:
      the relevant indexes

    • isHasRelevantResults

      public boolean isHasRelevantResults()
      Returns whether relevant results were found.
      Returns:
      true if relevant results exist

    • withRelevantDocs

      public static RelevanceEvaluationResult withRelevantDocs(List<String> relevantDocIds, List<Integer> relevantIndexes)
      Creates a result with relevant documents found.
      Parameters:
      relevantDocIds - list of relevant document IDs
      relevantIndexes - list of relevant indexes (1-based) from search results
      Returns:
      evaluation result

    • noRelevantResults

      public static RelevanceEvaluationResult noRelevantResults()
      Creates a result with no relevant documents found.
      Returns:
      evaluation result with no relevant documents

    • fallbackAllRelevant

      public static RelevanceEvaluationResult fallbackAllRelevant(List<String> allDocIds)
      Creates a fallback result that includes all documents as relevant. Used when evaluation fails and we want to include all search results.
      Parameters:
      allDocIds - all document IDs from search results
      Returns:
      evaluation result with all documents marked as relevant

    • toString

      public String toString()
      Overrides:
      toString in class Object