Class WatsonxScoringModel

java.lang.Object

dev.langchain4j.model.watsonx.WatsonxScoringModel

All Implemented Interfaces:

ScoringModel

public class WatsonxScoringModel
extends Object
implements ScoringModel

A ScoringModel implementation that integrates IBM watsonx.ai with LangChain4j.

Example usage:

ScoringModel scoringModel = new WatsonxScoringModel.builder()
    .url("https://...") // or use CloudRegion
    .apiKey("...")
    .projectId("...")
    .modelId("cross-encoder/ms-marco-minilm-l-12-v2")
    .build();

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	WatsonxScoringModel.Builder	Builder class for constructing WatsonxScoringModel instances with configurable parameters.

Method Summary

Modifier and Type	Method	Description
static WatsonxScoringModel.Builder	builder()	Returns a new WatsonxScoringModel.Builder instance.
Response<List<Double>>	scoreAll(List<TextSegment> segments, String query)	Scores all provided TextSegments against a given query.
Response<List<Double>>	scoreAll(List<TextSegment> segments, String query, com.ibm.watsonx.ai.rerank.RerankParameters parameters)	Scores all provided TextSegments against a given query using the given RerankParameters.

Methods inherited from class Object

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

Methods inherited from interface ScoringModel

score, score

Method Details

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.

scoreAll

public Response<List<Double>> scoreAll(List<TextSegment> segments,
 String query,
 com.ibm.watsonx.ai.rerank.RerankParameters parameters)

Scores all provided TextSegments against a given query using the given RerankParameters.

Parameters:

segments - The list of TextSegments to score.

query - The query against which to score the segments.

parameters - the rerank parameters to use.

Returns:

the list of scores. The order of scores corresponds to the order of TextSegments.

builder

public static WatsonxScoringModel.Builder builder()

Returns a new WatsonxScoringModel.Builder instance.

Example usage:

ScoringModel scoringModel = new WatsonxScoringModel.builder()
    .url("https://...") // or use CloudRegion
    .apiKey("...")
    .projectId("...")
    .modelId("cross-encoder/ms-marco-minilm-l-12-v2")
    .build();