Class DefaultRetrievalAugmentor.DefaultRetrievalAugmentorBuilder

java.lang.Object

dev.langchain4j.rag.DefaultRetrievalAugmentor.DefaultRetrievalAugmentorBuilder

Enclosing class:

DefaultRetrievalAugmentor

public static class DefaultRetrievalAugmentor.DefaultRetrievalAugmentorBuilder
extends Object

Method Summary

Modifier and Type	Method	Description
DefaultRetrievalAugmentor	build()
DefaultRetrievalAugmentor.DefaultRetrievalAugmentorBuilder	contentAggregator(ContentAggregator contentAggregator)
DefaultRetrievalAugmentor.DefaultRetrievalAugmentorBuilder	contentInjector(ContentInjector contentInjector)
DefaultRetrievalAugmentor.DefaultRetrievalAugmentorBuilder	contentRetriever(ContentRetriever contentRetriever)
DefaultRetrievalAugmentor.DefaultRetrievalAugmentorBuilder	executor(Executor executor)
DefaultRetrievalAugmentor.DefaultRetrievalAugmentorBuilder	offloadBlocking(boolean offloadBlocking)	Controls what DefaultRetrievalAugmentor.augmentAsync(AugmentationRequest) does when a pipeline stage (query transformation, routing, retrieval or aggregation) is not genuinely asynchronous (its *Async method is not implemented).
DefaultRetrievalAugmentor.DefaultRetrievalAugmentorBuilder	queryRouter(QueryRouter queryRouter)
DefaultRetrievalAugmentor.DefaultRetrievalAugmentorBuilder	queryTransformer(QueryTransformer queryTransformer)

Methods inherited from class Object

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

Method Details

contentRetriever

public DefaultRetrievalAugmentor.DefaultRetrievalAugmentorBuilder contentRetriever(ContentRetriever contentRetriever)

queryTransformer

public DefaultRetrievalAugmentor.DefaultRetrievalAugmentorBuilder queryTransformer(QueryTransformer queryTransformer)

queryRouter

public DefaultRetrievalAugmentor.DefaultRetrievalAugmentorBuilder queryRouter(QueryRouter queryRouter)

contentAggregator

public DefaultRetrievalAugmentor.DefaultRetrievalAugmentorBuilder contentAggregator(ContentAggregator contentAggregator)

contentInjector

public DefaultRetrievalAugmentor.DefaultRetrievalAugmentorBuilder contentInjector(ContentInjector contentInjector)

executor

public DefaultRetrievalAugmentor.DefaultRetrievalAugmentorBuilder executor(Executor executor)

offloadBlocking

@Experimental
public DefaultRetrievalAugmentor.DefaultRetrievalAugmentorBuilder offloadBlocking(boolean offloadBlocking)

Controls what DefaultRetrievalAugmentor.augmentAsync(AugmentationRequest) does when a pipeline stage (query transformation, routing, retrieval or aggregation) is not genuinely asynchronous (its *Async method is not implemented).

By default (false), augmentAsync fails with an actionable error naming the blocking stage, so a not-truly-async pipeline is never silently made "async" by parking a thread. Set to true to instead offload the blocking stage to the shared default executor (virtual threads on Java 21+, platform threads on 17-20) (the ExecutorProvider default) - not the synchronous fan-out executor. Has no effect on the synchronous DefaultRetrievalAugmentor.augment(AugmentationRequest).

Since:

1.20.0

build

public DefaultRetrievalAugmentor build()