Record Class ChatResponse

java.lang.Object

java.lang.Record

ch.tocco.nice2.optional.aiassistant.impl.function.ChatResponse

Record Components:

answer - the grounded, cited answer in the requested language

sources - distinct citations provided as context, ranked by relevance; the frontend decides how many to show (may be empty for functions that don't cite)

public record ChatResponse(String answer, List<ChatResponse.Source> sources)
extends Record

The result an AssistantFunction returns for one turn.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	ChatResponse.Source	A cited page.

Constructor Summary

Constructors

Constructor	Description
ChatResponse(String answer, List<ChatResponse.Source> sources)	Creates an instance of a ChatResponse record class.

Method Summary

Modifier and Type	Method	Description
String	answer()	Returns the value of the answer record component.
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.
List<ChatResponse.Source>	sources()	Returns the value of the sources record component.
final 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

ChatResponse

public ChatResponse(String answer,
 List<ChatResponse.Source> sources)

Creates an instance of a ChatResponse record class.

Parameters:

answer - the value for the answer record component

sources - the value for the sources record component

Method Details

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.

answer

public String answer()

Returns the value of the answer record component.

Returns:

the value of the answer record component

sources

public List<ChatResponse.Source> sources()

Returns the value of the sources record component.

Returns:

the value of the sources record component