Package dev.langchain4j.adaptiverag

Record Class RetrievalGrader

java.lang.Object

java.lang.Record

dev.langchain4j.adaptiverag.RetrievalGrader

All Implemented Interfaces:

Function<RetrievalGrader.Arguments,RetrievalGrader.Score>

public record RetrievalGrader(String openApiKey)
extends Record
implements Function<RetrievalGrader.Arguments,RetrievalGrader.Score>

The RetrievalGrader class implements a function to assess the relevance of a retrieved document to a user's question. It uses an AI service to generate a binary score ('yes' or 'no') indicating relevance. This class relies on external services for processing and grading documents, making it dependent on network availability and the stability of the used API.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	RetrievalGrader.Arguments	Represents a structure for holding the arguments needed to process a user's query.
static class	RetrievalGrader.Score	A static class that represents a score in a binary format.

Constructor Summary

Constructors

Constructor	Description
RetrievalGrader(String openApiKey)	Creates an instance of a RetrievalGrader record class.

Method Summary

Modifier and Type	Method	Description
RetrievalGrader.Score	apply(RetrievalGrader.Arguments args)	Applies the provided arguments to generate a score using a chat language model.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
String	openApiKey()	Returns the value of the openApiKey record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.function.Function

andThen, compose

Constructor Details

RetrievalGrader

public RetrievalGrader(String openApiKey)

Creates an instance of a RetrievalGrader record class.

Parameters:

openApiKey - the value for the openApiKey record component

Method Details

apply

public RetrievalGrader.Score apply(RetrievalGrader.Arguments args)

Applies the provided arguments to generate a score using a chat language model.

Specified by:

apply in interface Function<RetrievalGrader.Arguments,RetrievalGrader.Score>

Parameters:

args - The arguments containing the necessary information for processing.

Returns:

A RetrievalGrader.Score object representing the result of the processing.

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

openApiKey

public String openApiKey()

Returns the value of the openApiKey record component.

Returns:

the value of the openApiKey record component