Class CohereScoringModel

java.lang.Object

dev.langchain4j.model.cohere.CohereScoringModel

All Implemented Interfaces:

ScoringModel

public class CohereScoringModel
extends Object
implements ScoringModel

An implementation of a ScoringModel that uses Cohere Rerank API.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CohereScoringModel.CohereScoringModelBuilder

Constructor Summary

Constructors

Constructor	Description
CohereScoringModel(CohereScoringModel.CohereScoringModelBuilder builder)
CohereScoringModel(String baseUrl, String apiKey, String modelName, Duration timeout, Integer maxRetries, Proxy proxy, Boolean logRequests, Boolean logResponses)	Deprecated, for removal: This API element is subject to removal in a future version.

Method Summary

Modifier and Type	Method	Description
static CohereScoringModel.CohereScoringModelBuilder	builder()
CompletableFuture<ScoringResponse>	doScoreAsync(ScoringRequest scoringRequest)	Genuinely non-blocking counterpart of scoreAll(List, String), used by the asynchronous and reactive RAG flow.
Response<List<Double>>	scoreAll(List<TextSegment> segments, String query)	Scores all provided TextSegments against a given query.
static CohereScoringModel	withApiKey(String apiKey)	Deprecated, for removal: This API element is subject to removal in a future version. Please use builder() instead, and explicitly set the model name and, if necessary, other parameters.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface ScoringModel

defaultRequestParameters, score, score, scoreAsync

Constructor Details

CohereScoringModel

@Deprecated(forRemoval=true,
            since="1.4.0")
public CohereScoringModel(String baseUrl,
 String apiKey,
 String modelName,
 Duration timeout,
 Integer maxRetries,
 Proxy proxy,
 Boolean logRequests,
 Boolean logResponses)

Deprecated, for removal: This API element is subject to removal in a future version.

CohereScoringModel

public CohereScoringModel(CohereScoringModel.CohereScoringModelBuilder builder)

Method Details

withApiKey

@Deprecated(forRemoval=true)
public static CohereScoringModel withApiKey(String apiKey)

Deprecated, for removal: This API element is subject to removal in a future version.

Please use builder() instead, and explicitly set the model name and, if necessary, other parameters.

builder

public static CohereScoringModel.CohereScoringModelBuilder builder()

scoreAll

public Response<List<Double>> scoreAll(List<TextSegment> segments,
 String query)

Description copied from interface: ScoringModel

Scores all provided TextSegments against a given query.

Specified by:

scoreAll in interface ScoringModel

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.

doScoreAsync

public CompletableFuture<ScoringResponse> doScoreAsync(ScoringRequest scoringRequest)

Genuinely non-blocking counterpart of scoreAll(List, String), used by the asynchronous and reactive RAG flow. The underlying HTTP call is dispatched asynchronously (no thread is parked while it is in flight), and cancelling the returned future aborts the in-flight call (best-effort).

Like scoreAll(List, String), a failed request is retried up to maxRetries times (retry-around-future, composing futures without parking a thread); a cancellation is never retried.

Specified by:

doScoreAsync in interface ScoringModel

Parameters:

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

Returns:

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