Class EmbeddingStoreContentRetriever.EmbeddingStoreContentRetrieverBuilder

java.lang.Object

dev.langchain4j.rag.content.retriever.EmbeddingStoreContentRetriever.EmbeddingStoreContentRetrieverBuilder

Enclosing class:

EmbeddingStoreContentRetriever

public static class EmbeddingStoreContentRetriever.EmbeddingStoreContentRetrieverBuilder
extends Object

Method Summary

Modifier and Type	Method	Description
EmbeddingStoreContentRetriever	build()
EmbeddingStoreContentRetriever.EmbeddingStoreContentRetrieverBuilder	displayName(String displayName)
EmbeddingStoreContentRetriever.EmbeddingStoreContentRetrieverBuilder	dynamicFilter(Function<Query,Filter> dynamicFilter)
EmbeddingStoreContentRetriever.EmbeddingStoreContentRetrieverBuilder	dynamicMaxResults(Function<Query,Integer> dynamicMaxResults)
EmbeddingStoreContentRetriever.EmbeddingStoreContentRetrieverBuilder	dynamicMinScore(Function<Query,Double> dynamicMinScore)
EmbeddingStoreContentRetriever.EmbeddingStoreContentRetrieverBuilder	embeddingInputType(EmbeddingInputType embeddingInputType)	Embeds the query with the given EmbeddingInputType (typically EmbeddingInputType.QUERY), so providers that encode queries and documents differently can produce a query-optimized embedding.
EmbeddingStoreContentRetriever.EmbeddingStoreContentRetrieverBuilder	embeddingModel(EmbeddingModel embeddingModel)
EmbeddingStoreContentRetriever.EmbeddingStoreContentRetrieverBuilder	embeddingStore(EmbeddingStore<TextSegment> embeddingStore)
EmbeddingStoreContentRetriever.EmbeddingStoreContentRetrieverBuilder	filter(Filter filter)
EmbeddingStoreContentRetriever.EmbeddingStoreContentRetrieverBuilder	maxResults(Integer maxResults)
EmbeddingStoreContentRetriever.EmbeddingStoreContentRetrieverBuilder	minScore(Double minScore)
EmbeddingStoreContentRetriever.EmbeddingStoreContentRetrieverBuilder	offloadBlocking(boolean offloadBlocking)	Controls what EmbeddingStoreContentRetriever.retrieveAsync(Query) does when the EmbeddingModel or EmbeddingStore is not genuinely asynchronous (does not implement doEmbedAsync/searchAsync).

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

embeddingInputType

public EmbeddingStoreContentRetriever.EmbeddingStoreContentRetrieverBuilder embeddingInputType(EmbeddingInputType embeddingInputType)

Embeds the query with the given EmbeddingInputType (typically EmbeddingInputType.QUERY), so providers that encode queries and documents differently can produce a query-optimized embedding.

When left null (the default), no input type is sent. If set, the chosen EmbeddingModel must support the input type parameter, otherwise the query embedding fails fast.

maxResults

public EmbeddingStoreContentRetriever.EmbeddingStoreContentRetrieverBuilder maxResults(Integer maxResults)

minScore

public EmbeddingStoreContentRetriever.EmbeddingStoreContentRetrieverBuilder minScore(Double minScore)

filter

public EmbeddingStoreContentRetriever.EmbeddingStoreContentRetrieverBuilder filter(Filter filter)

displayName

public EmbeddingStoreContentRetriever.EmbeddingStoreContentRetrieverBuilder displayName(String displayName)

embeddingStore

public EmbeddingStoreContentRetriever.EmbeddingStoreContentRetrieverBuilder embeddingStore(EmbeddingStore<TextSegment> embeddingStore)

embeddingModel

public EmbeddingStoreContentRetriever.EmbeddingStoreContentRetrieverBuilder embeddingModel(EmbeddingModel embeddingModel)

dynamicMaxResults

public EmbeddingStoreContentRetriever.EmbeddingStoreContentRetrieverBuilder dynamicMaxResults(Function<Query,Integer> dynamicMaxResults)

dynamicMinScore

public EmbeddingStoreContentRetriever.EmbeddingStoreContentRetrieverBuilder dynamicMinScore(Function<Query,Double> dynamicMinScore)

dynamicFilter

public EmbeddingStoreContentRetriever.EmbeddingStoreContentRetrieverBuilder dynamicFilter(Function<Query,Filter> dynamicFilter)

offloadBlocking

@Experimental
public EmbeddingStoreContentRetriever.EmbeddingStoreContentRetrieverBuilder offloadBlocking(boolean offloadBlocking)

Controls what EmbeddingStoreContentRetriever.retrieveAsync(Query) does when the EmbeddingModel or EmbeddingStore is not genuinely asynchronous (does not implement doEmbedAsync/searchAsync).

By default (false), retrieveAsync fails with an UnsupportedFeatureException naming the blocking component, so a not-truly-async pipeline is never silently made "async" by parking a thread. Set to true to instead offload only the blocking component(s) - the embedding call and/or the store search - to the shared default executor (virtual threads on Java 21+, platform threads on 17-20), while any async component keeps running on its native path. A deliberate opt-in to blocking-on-a-(virtual)-thread; has no effect on the synchronous EmbeddingStoreContentRetriever.retrieve(Query).

Since:

1.20.0

build

public EmbeddingStoreContentRetriever build()