Class OnnxScoringModel

java.lang.Object

dev.langchain4j.model.scoring.onnx.OnnxScoringModel

All Implemented Interfaces:

ScoringModel, AutoCloseable

public class OnnxScoringModel
extends Object

Constructor Summary

Constructors

Constructor	Description
OnnxScoringModel(String pathToModel, ai.onnxruntime.OrtSession.SessionOptions options, String pathToTokenizer)
OnnxScoringModel(String pathToModel, ai.onnxruntime.OrtSession.SessionOptions options, String pathToTokenizer, int modelMaxLength, boolean normalize)
OnnxScoringModel(String pathToModel, String pathToTokenizer)
OnnxScoringModel(String pathToModel, String pathToTokenizer, int modelMaxLength)

Method Summary

Modifier and Type	Method	Description
void	close()
ScoringResponse	doScore(ScoringRequest request)	The provider hook behind ScoringModel.score(ScoringRequest).
protected dev.langchain4j.model.scoring.onnx.OnnxScoringBertCrossEncoder	model()
Response<List<Double>>	scoreAll(List<TextSegment> segments, String query)	Scores all provided TextSegments against a given query.

Methods inherited from class Object

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

Methods inherited from interface ScoringModel

defaultRequestParameters, doScoreAsync, listeners, provider, score, score, score, scoreAsync

Constructor Details

OnnxScoringModel

public OnnxScoringModel(String pathToModel,
 String pathToTokenizer)

OnnxScoringModel

public OnnxScoringModel(String pathToModel,
 ai.onnxruntime.OrtSession.SessionOptions options,
 String pathToTokenizer)

OnnxScoringModel

public OnnxScoringModel(String pathToModel,
 String pathToTokenizer,
 int modelMaxLength)

OnnxScoringModel

public OnnxScoringModel(String pathToModel,
 ai.onnxruntime.OrtSession.SessionOptions options,
 String pathToTokenizer,
 int modelMaxLength,
 boolean normalize)

Method Details

model

protected dev.langchain4j.model.scoring.onnx.OnnxScoringBertCrossEncoder model()

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.

doScore

public ScoringResponse doScore(ScoringRequest request)

Description copied from interface: ScoringModel

The provider hook behind ScoringModel.score(ScoringRequest).

The default scores the documents with ScoringModel.scoreAll(List, String), so a model that implements only ScoringModel.scoreAll(List, String) also supports ScoringModel.score(ScoringRequest). To do so, the default turns each document into a TextSegment, and a TextSegment cannot be blank: a model that implements only ScoringModel.scoreAll(List, String) therefore cannot score blank documents through ScoringModel.score(ScoringRequest), and such a request fails with an IllegalArgumentException.

To support listeners, override this method and implement ScoringModel.scoreAll(List, String) by calling ScoringModel.score(ScoringRequest), so that the listeners are also notified when ScoringModel.scoreAll(List, String) is called. Never make ScoringModel.scoreAll(List, String) call ScoringModel.score(ScoringRequest) without overriding this method: each method would call the other.

Specified by:

doScore in interface ScoringModel

Parameters:

request - the request, with the default parameters already applied.

Returns:

the scores, in the order of ScoringRequest.documents(), and the response metadata.

close

public void close()

Specified by:

close in interface AutoCloseable