Package org.springframework.ai.rag.advisor

Class RetrievalAugmentationAdvisor

java.lang.Object
org.springframework.ai.rag.advisor.RetrievalAugmentationAdvisor
All Implemented Interfaces:
org.springframework.ai.chat.client.advisor.api.Advisor, org.springframework.ai.chat.client.advisor.api.BaseAdvisor, org.springframework.ai.chat.client.advisor.api.CallAdvisor, org.springframework.ai.chat.client.advisor.api.StreamAdvisor, org.springframework.core.Ordered
public final class RetrievalAugmentationAdvisor extends Object implements org.springframework.ai.chat.client.advisor.api.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:

  • 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

  • Method Summary

    Modifier and Type
    Method
    Description
    org.springframework.ai.chat.client.ChatClientResponse
    after(org.springframework.ai.chat.client.ChatClientResponse chatClientResponse, org.springframework.ai.chat.client.advisor.api.AdvisorChain advisorChain)
     
    org.springframework.ai.chat.client.ChatClientRequest
    before(org.springframework.ai.chat.client.ChatClientRequest chatClientRequest, org.springframework.ai.chat.client.advisor.api.AdvisorChain advisorChain)
     
    static RetrievalAugmentationAdvisor.Builder
    builder()
     
    int
    getOrder()
     
    reactor.core.scheduler.Scheduler
    getScheduler()
     

    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

    adviseCall, adviseStream, getName

  • Field Details

  • Method Details

    • builder

      public static RetrievalAugmentationAdvisor.Builder builder()

    • before

      public org.springframework.ai.chat.client.ChatClientRequest before(org.springframework.ai.chat.client.ChatClientRequest chatClientRequest, @Nullable org.springframework.ai.chat.client.advisor.api.AdvisorChain advisorChain)
      Specified by:
      before in interface org.springframework.ai.chat.client.advisor.api.BaseAdvisor

    • after

      public org.springframework.ai.chat.client.ChatClientResponse after(org.springframework.ai.chat.client.ChatClientResponse chatClientResponse, @Nullable org.springframework.ai.chat.client.advisor.api.AdvisorChain advisorChain)
      Specified by:
      after in interface org.springframework.ai.chat.client.advisor.api.BaseAdvisor

    • getScheduler

      public reactor.core.scheduler.Scheduler getScheduler()
      Specified by:
      getScheduler in interface org.springframework.ai.chat.client.advisor.api.BaseAdvisor

    • getOrder

      public int getOrder()
      Specified by:
      getOrder in interface org.springframework.core.Ordered