Package org.springframework.ai.rag.advisor

Class RetrievalAugmentationAdvisor

java.lang.Object

org.springframework.ai.rag.advisor.RetrievalAugmentationAdvisor

All Implemented Interfaces:

Advisor, BaseAdvisor, CallAroundAdvisor, StreamAroundAdvisor, org.springframework.core.Ordered

public final class RetrievalAugmentationAdvisor
extends Object
implements BaseAdvisor

Advisor that implements common Retrieval Augmented Generation (RAG) flows using the building blocks defined in the org.springframework.ai.rag package and following the Modular RAG Architecture.

Since:

1.0.0

Author:

Christian Tzolov, Thomas Vitale

See Also:

• arXiv:2407.21059
• arXiv:2312.10997
• arXiv:2410.20878

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	RetrievalAugmentationAdvisor.Builder

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DOCUMENT_CONTEXT

Fields inherited from interface org.springframework.ai.chat.client.advisor.api.Advisor

DEFAULT_CHAT_MEMORY_PRECEDENCE_ORDER

Fields inherited from interface org.springframework.ai.chat.client.advisor.api.BaseAdvisor

DEFAULT_SCHEDULER

Fields inherited from interface org.springframework.core.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Constructor	Description
RetrievalAugmentationAdvisor(List<QueryTransformer> queryTransformers, QueryExpander queryExpander, DocumentRetriever documentRetriever, DocumentJoiner documentJoiner, QueryAugmenter queryAugmenter, org.springframework.core.task.TaskExecutor taskExecutor, reactor.core.scheduler.Scheduler scheduler, Integer order)

Method Summary

Modifier and Type	Method	Description
AdvisedResponse	after(AdvisedResponse advisedResponse)	Logic to be executed after the rest of the advisor chain is called.
AdvisedRequest	before(AdvisedRequest request)	Logic to be executed before the rest of the advisor chain is called.
static RetrievalAugmentationAdvisor.Builder	builder()
int	getOrder()
reactor.core.scheduler.Scheduler	getScheduler()	Scheduler used for processing the advisor logic when streaming.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.ai.chat.client.advisor.api.BaseAdvisor

aroundCall, aroundStream, getName

Field Details

DOCUMENT_CONTEXT

public static final String DOCUMENT_CONTEXT

See Also:

• Constant Field Values

Constructor Details

RetrievalAugmentationAdvisor

public RetrievalAugmentationAdvisor(@Nullable
 List<QueryTransformer> queryTransformers,
 @Nullable
 QueryExpander queryExpander,
 DocumentRetriever documentRetriever,
 @Nullable
 DocumentJoiner documentJoiner,
 @Nullable
 QueryAugmenter queryAugmenter,
 @Nullable
 org.springframework.core.task.TaskExecutor taskExecutor,
 @Nullable
 reactor.core.scheduler.Scheduler scheduler,
 @Nullable
 Integer order)

Method Details

builder

public static RetrievalAugmentationAdvisor.Builder builder()

before

public AdvisedRequest before(AdvisedRequest request)

Description copied from interface: BaseAdvisor

Logic to be executed before the rest of the advisor chain is called.

Specified by:

before in interface BaseAdvisor

after

public AdvisedResponse after(AdvisedResponse advisedResponse)

Description copied from interface: BaseAdvisor

Logic to be executed after the rest of the advisor chain is called.

Specified by:

after in interface BaseAdvisor

getScheduler

public reactor.core.scheduler.Scheduler getScheduler()

Description copied from interface: BaseAdvisor

Scheduler used for processing the advisor logic when streaming.

Specified by:

getScheduler in interface BaseAdvisor

getOrder

public int getOrder()

Specified by:

getOrder in interface org.springframework.core.Ordered