Record Class EvaluationSample

java.lang.Object

java.lang.Record

io.micronaut.langchain4j.test.EvaluationSample

Record Components:

name - The name of the sample, shown in the test reports

input - The input sent to the AI service

context - The context that the response must be grounded in, if any

expected - The expected response, if any

public record EvaluationSample(String name, String input, @Nullable String context, @Nullable String expected)
extends Record

A sample of an evaluation: the input sent to the AI service, with the optional context that the response must be grounded in and the optional expected response, loaded from a sample file by EvaluationSamples.

Since:

2.4.0

Constructor Summary

Constructors

Constructor	Description
EvaluationSample(String name, String input, @Nullable String context, @Nullable String expected)	Creates an instance of a EvaluationSample record class.

Method Summary

Modifier and Type	Method	Description
@Nullable String	context()	Returns the value of the context record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
@Nullable String	expected()	Returns the value of the expected record component.
final int	hashCode()	Returns a hash code value for this object.
String	input()	Returns the value of the input record component.
String	name()	Returns the value of the name record component.
EvaluationRequest	request(String response)	Creates the request that evaluates the response to this sample.
String	toString()	Returns a string representation of this record class.

Methods inherited from class Object

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

Constructor Details

EvaluationSample

public EvaluationSample(String name,
 String input,
 @Nullable String context,
 @Nullable String expected)

Creates an instance of a EvaluationSample record class.

Parameters:

name - the value for the name record component

input - the value for the input record component

context - the value for the context record component

expected - the value for the expected record component

Method Details

request

public EvaluationRequest request(String response)

Creates the request that evaluates the response to this sample.

Parameters:

response - The response of the AI service

Returns:

The evaluation request

toString

public 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.

name

public String name()

Returns the value of the name record component.

Returns:

the value of the name record component

input

public String input()

Returns the value of the input record component.

Returns:

the value of the input record component

context

public @Nullable String context()

Returns the value of the context record component.

Returns:

the value of the context record component

expected

public @Nullable String expected()

Returns the value of the expected record component.

Returns:

the value of the expected record component