Package com.tnsai.rag

Class SearchSettings

java.lang.Object

com.tnsai.rag.SearchSettings

public final class SearchSettings
extends Object

The search settings one knowledge entry contributes to its scope: a partial, immutable value holding only the Search members that were given.

An entry's settings merge member by member with the other SEARCH entries of its scope, so a member that is not given here leaves the scope's value, or the default, in place. Build one with builder() or read one from a Search declaration with of(Search).

Since:

0.18.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	SearchSettings.Builder	Builds SearchSettings; a member not set is not given.

Method Summary

Modifier and Type	Method	Description
static SearchSettings.Builder	builder()	Starts settings that give no member.
Optional<Boolean>	cache()
OptionalInt	cacheTTL()
Optional<String>	contextFormat()
OptionalInt	contextWindow()
OptionalDouble	dedupeThreshold()
Optional<Boolean>	deduplicate()
boolean	equals(Object other)
OptionalInt	expandedQueries()
int	hashCode()
Optional<Boolean>	includeSpec()
SearchSettings	layer(SearchSettings over)	These settings with every member over gives replacing the one given here.
OptionalInt	maxStaleness()
Set<String>	members()
OptionalDouble	minScore()
Optional<String>	navigatorModel()
static SearchSettings	of(Search search)	The members a Search declaration gives.
Optional<Search.FallbackAction>	onFailure()
Optional<Search.QueryExpansion>	queryExpansion()
Optional<String>	queryExpansionModel()
Optional<String>	queryParam()
Optional<Boolean>	rerank()
Optional<String>	rerankerModel()
Optional<Search.Strategy>	strategy()
OptionalInt	topK()
OptionalInt	topN()
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Details

builder

public static SearchSettings.Builder builder()

Starts settings that give no member.

Returns:

a new builder

of

public static SearchSettings of(Search search)

The members a Search declaration gives.

Parameters:

search - the declaration

Returns:

settings holding each member the declaration gives one value for

Throws:

IllegalArgumentException - when a member holds more than one value

members

public Set<String> members()

Returns:

the names of the members these settings give, in name order

layer

public SearchSettings layer(SearchSettings over)

These settings with every member over gives replacing the one given here.

Parameters:

over - the settings that win

Returns:

the layered settings

strategy

public Optional<Search.Strategy> strategy()

queryParam

public Optional<String> queryParam()

rerank

public Optional<Boolean> rerank()

rerankerModel

public Optional<String> rerankerModel()

contextWindow

public OptionalInt contextWindow()

topK

public OptionalInt topK()

topN

public OptionalInt topN()

minScore

public OptionalDouble minScore()

deduplicate

public Optional<Boolean> deduplicate()

dedupeThreshold

public OptionalDouble dedupeThreshold()

queryExpansion

public Optional<Search.QueryExpansion> queryExpansion()

queryExpansionModel

public Optional<String> queryExpansionModel()

navigatorModel

public Optional<String> navigatorModel()

expandedQueries

public OptionalInt expandedQueries()

includeSpec

public Optional<Boolean> includeSpec()

contextFormat

public Optional<String> contextFormat()

cache

public Optional<Boolean> cache()

cacheTTL

public OptionalInt cacheTTL()

maxStaleness

public OptionalInt maxStaleness()

onFailure

public Optional<Search.FallbackAction> onFailure()

equals

public boolean equals(Object other)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object