Class ScoringRequest

java.lang.Object

dev.langchain4j.model.scoring.request.ScoringRequest

@Experimental
public class ScoringRequest
extends Object

A request to score (re-rank) a list of documents() against a query().

A scoring model produces one relevance score per document; the resulting ScoringResponse carries the scores in the same order as documents. Optional per-call parameters (such as the model name) are carried alongside.

Since:

1.20.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ScoringRequest.Builder

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ScoringRequest(ScoringRequest.Builder builder)

Method Summary

Modifier and Type	Method	Description
static ScoringRequest.Builder	builder()
List<String>	documents()	The documents to score against the query().
boolean	equals(Object o)
int	hashCode()
String	modelName()	Convenience accessor for parameters().modelName().
ScoringRequestParameters	parameters()	The per-call parameters of this request; never null (ScoringRequestParameters.EMPTY if unset).
String	query()	The query against which the documents() are scored.
String	toString()

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

ScoringRequest

protected ScoringRequest(ScoringRequest.Builder builder)

Method Details

documents

public List<String> documents()

The documents to score against the query(). The response scores are in this order.

query

public String query()

The query against which the documents() are scored.

parameters

public ScoringRequestParameters parameters()

The per-call parameters of this request; never null (ScoringRequestParameters.EMPTY if unset).

modelName

public String modelName()

Convenience accessor for parameters().modelName().

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

builder

public static ScoringRequest.Builder builder()