Record Class ChatResponse.Source

java.lang.Object

java.lang.Record

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

Record Components:

title - the page title (raw; the frontend adds the suffix when disambiguating)

url - deep link to the page

rank - 1-based relevance rank (1 = most relevant); the frontend shows the best N

sourceType - "MANUAL" or "SYSDOC" (machine-readable)

sourceLabel - localized display term for the source ("Handbuch" / "Systembeschreibung"), which the frontend appends when two shown sources share a title

Enclosing class:

ChatResponse

public static record ChatResponse.Source(String title, String url, int rank, String sourceType, String sourceLabel)
extends Record

A cited page.

Constructor Summary

Constructors

Constructor	Description
Source(String title, String url, int rank, String sourceType, String sourceLabel)	Creates an instance of a Source record class.

Method Summary

Modifier and Type	Method	Description
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.
int	rank()	Returns the value of the rank record component.
String	sourceLabel()	Returns the value of the sourceLabel record component.
String	sourceType()	Returns the value of the sourceType record component.
String	title()	Returns the value of the title record component.
final String	toString()	Returns a string representation of this record class.
String	url()	Returns the value of the url record component.

Methods inherited from class Object

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

Constructor Details

Source

public Source(String title,
 String url,
 int rank,
 String sourceType,
 String sourceLabel)

Creates an instance of a Source record class.

Parameters:

title - the value for the title record component

url - the value for the url record component

rank - the value for the rank record component

sourceType - the value for the sourceType record component

sourceLabel - the value for the sourceLabel 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. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with the compare method from their corresponding wrapper classes.

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.

title

public String title()

Returns the value of the title record component.

Returns:

the value of the title record component

url

public String url()

Returns the value of the url record component.

Returns:

the value of the url record component

rank

public int rank()

Returns the value of the rank record component.

Returns:

the value of the rank record component

sourceType

public String sourceType()

Returns the value of the sourceType record component.

Returns:

the value of the sourceType record component

sourceLabel

public String sourceLabel()

Returns the value of the sourceLabel record component.

Returns:

the value of the sourceLabel record component