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 Summary

Modifier and Type	Method	Description
default ScoringRequestParameters	defaultRequestParameters()	The model's default per-call parameters, applied by scoreAsync(ScoringRequest) to every request and overridden by any parameters set on the request itself.
default CompletableFuture<ScoringResponse>	doScoreAsync(ScoringRequest request)	The provider hook behind scoreAsync(ScoringRequest).
default Response<Double>	score(TextSegment segment, String query)	Scores a given TextSegment against a given query.
default Response<Double>	score(String text, String query)	Scores a given text against a given query.
Response<List<Double>>	scoreAll(List<TextSegment> segments, String query)	Scores all provided TextSegments against a given query.
default CompletableFuture<ScoringResponse>	scoreAsync(ScoringRequest request)	Scores the documents of the given request against its query without blocking the calling thread — the asynchronous/reactive counterpart of scoreAll(List, String), used by the non-blocking RAG flow (see ReRankingContentAggregator).

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.

scoreAsync

@Experimental
default CompletableFuture<ScoringResponse> scoreAsync(ScoringRequest request)

Scores the documents of the given request against its query without blocking the calling thread — the asynchronous/reactive counterpart of scoreAll(List, String), used by the non-blocking RAG flow (see ReRankingContentAggregator).

This applies the model's default parameters and dispatches to doScoreAsync(ScoringRequest); a model becomes genuinely non-blocking by overriding the latter.

Parameters:

request - the documents to score, the query, and the per-call parameters.

Returns:

a CompletableFuture of the scores, in the order of ScoringRequest.documents().

Since:

1.20.0

doScoreAsync

@Experimental
default CompletableFuture<ScoringResponse> doScoreAsync(ScoringRequest request)

The provider hook behind scoreAsync(ScoringRequest). The default returns a failed future carrying AsyncNotSupportedException: a scoring model that is not genuinely asynchronous does not pretend to be. A model backed by remote HTTP I/O opts in by overriding this with a genuinely async call (no thread parked), and should abort its in-flight call when the returned future is cancelled (best-effort). A model that has not opted in fails loudly on the async path rather than silently blocking a carrier thread.

Parameters:

request - the (already defaults-applied) request to score.

Returns:

a CompletableFuture of the scores, in the order of ScoringRequest.documents().

Since:

1.20.0

defaultRequestParameters

@Experimental
default ScoringRequestParameters defaultRequestParameters()

The model's default per-call parameters, applied by scoreAsync(ScoringRequest) to every request and overridden by any parameters set on the request itself. The default is ScoringRequestParameters.EMPTY.

Since:

1.20.0