Package dev.langchain4j.adaptiverag

Record Class HallucinationGrader

java.lang.Object

java.lang.Record

dev.langchain4j.adaptiverag.HallucinationGrader

All Implemented Interfaces:

Function<HallucinationGrader.Arguments,HallucinationGrader.Score>

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

Provides functionality to grade the groundedness of an LLM generation with respect to a set of facts. The class implements the Function interface, which accepts parameters of type HallucinationGrader.Arguments and returns a score indicating whether the generation is grounded or not.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	HallucinationGrader.Arguments	Represents a set of facts and an associated LLM generation.
static class	HallucinationGrader.Score	Binary score for hallucination present in generation answer.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
HallucinationGrader.Score	apply(HallucinationGrader.Arguments args)	Applies the provided arguments to a chat language model and returns the score.
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

HallucinationGrader

public HallucinationGrader(String openApiKey)

Creates an instance of a HallucinationGrader record class.

Parameters:

openApiKey - the value for the openApiKey record component

Method Details

apply

public HallucinationGrader.Score apply(HallucinationGrader.Arguments args)

Applies the provided arguments to a chat language model and returns the score. Uses OpenAI's GPT-3.5-Turbo model with specified settings. Logs requests and responses, retries twice, and has a max token limit of 2000.

Specified by:

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

Parameters:

args - The arguments to be applied.

Returns:

A Score object from the AI grader's invocation.

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