Package sk.iway.iwcm.rag.search

Record Class MarkdownSearchService.SearchResponse

java.lang.Object

java.lang.Record

sk.iway.iwcm.rag.search.MarkdownSearchService.SearchResponse

Record Components:

results - unique authorized source results

answer - plain-text answer, or null when none is available

answerHtml - answer with safe formatting only, or null when none is available

Enclosing class:

MarkdownSearchService

public static record MarkdownSearchService.SearchResponse(List<MarkdownSearchService.SearchResult> results, String answer, String answerHtml)
extends Record

Carries ranked documentation sources and an optional generated answer.

Constructor Summary

Constructors

Constructor	Description
SearchResponse(List<MarkdownSearchService.SearchResult> results, String answer, String answerHtml)	Creates an instance of a SearchResponse record class.

Method Summary

Modifier and Type	Method	Description
String	answer()	Returns the value of the answer record component.
String	answerHtml()	Returns the value of the answerHtml 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<MarkdownSearchService.SearchResult>	results()	Returns the value of the results 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

Constructor Details

SearchResponse

public SearchResponse(List<MarkdownSearchService.SearchResult> results,
 String answer,
 String answerHtml)

Creates an instance of a SearchResponse record class.

Parameters:

results - the value for the results record component

answer - the value for the answer record component

answerHtml - the value for the answerHtml 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.

results

public List<MarkdownSearchService.SearchResult> results()

Returns the value of the results record component.

Returns:

the value of the results record component

answer

public String answer()

Returns the value of the answer record component.

Returns:

the value of the answer record component

answerHtml

public String answerHtml()

Returns the value of the answerHtml record component.

Returns:

the value of the answerHtml record component