Interface ScoringModel

All Known Implementing Classes:
CohereScoringModel, JinaScoringModel, OnnxScoringModel, VertexAiScoringModel, VoyageAiScoringModel, WatsonxScoringModel
public interface ScoringModel
Represents a model capable of scoring a text against a query.
Useful for identifying the most relevant texts when scoring multiple texts against the same query.
The scoring model can be employed for re-ranking purposes.

  • Method Details

    • score

      default Response<Double> score(String text, String query)
      Scores a given text against a given query.
      Parameters:
      text - The text to be scored.
      query - The query against which to score the text.
      Returns:
      the score.

    • score

      default Response<Double> score(TextSegment segment, String query)
      Scores a given TextSegment against a given query.
      Parameters:
      segment - The TextSegment to be scored.
      query - The query against which to score the segment.
      Returns:
      the score.

    • scoreAll

      Response<List<Double>> scoreAll(List<TextSegment> segments, String query)
      Scores all provided TextSegments against a given query.
      Parameters:
      segments - The list of TextSegments to score.
      query - The query against which to score the segments.
      Returns:
      the list of scores. The order of scores corresponds to the order of TextSegments.