Package com.alibaba.cloud.ai.advisor

Class RetrievalRerankAdvisor

java.lang.Object
com.alibaba.cloud.ai.advisor.RetrievalRerankAdvisor
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 class RetrievalRerankAdvisor extends Object implements org.springframework.ai.chat.client.advisor.api.BaseAdvisor
Title Content rerank advisor.
Description Content rerank advisor.
Since:
1.0.0-M2
Author:
yuanci.ytb

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    FILTER_EXPRESSION
     
    static final String
    RETRIEVED_DOCUMENTS
     

    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
    RetrievalRerankAdvisor(org.springframework.ai.vectorstore.VectorStore vectorStore, RerankModel rerankModel)
     
    RetrievalRerankAdvisor(org.springframework.ai.vectorstore.VectorStore vectorStore, RerankModel rerankModel, Double score)
     
    RetrievalRerankAdvisor(org.springframework.ai.vectorstore.VectorStore vectorStore, RerankModel rerankModel, org.springframework.ai.vectorstore.SearchRequest searchRequest)
     
    RetrievalRerankAdvisor(org.springframework.ai.vectorstore.VectorStore vectorStore, RerankModel rerankModel, org.springframework.ai.vectorstore.SearchRequest searchRequest, org.springframework.ai.chat.prompt.PromptTemplate promptTemplate, Double minScore)
     
    RetrievalRerankAdvisor(org.springframework.ai.vectorstore.VectorStore vectorStore, RerankModel rerankModel, org.springframework.ai.vectorstore.SearchRequest searchRequest, org.springframework.ai.chat.prompt.PromptTemplate promptTemplate, Double minScore, int order)
     

  • 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 request, org.springframework.ai.chat.client.advisor.api.AdvisorChain advisorChain)
     
    protected org.springframework.ai.vectorstore.filter.Filter.Expression
    doGetFilterExpression(Map<String,Object> context)
     
    protected List<org.springframework.ai.document.Document>
    doRerank(org.springframework.ai.chat.client.ChatClientRequest request, List<org.springframework.ai.document.Document> documents)
     
    int
    getOrder()
     

    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, getScheduler

  • Field Details

  • Constructor Details

    • RetrievalRerankAdvisor

      public RetrievalRerankAdvisor(org.springframework.ai.vectorstore.VectorStore vectorStore, RerankModel rerankModel)

    • RetrievalRerankAdvisor

      public RetrievalRerankAdvisor(org.springframework.ai.vectorstore.VectorStore vectorStore, RerankModel rerankModel, Double score)

    • RetrievalRerankAdvisor

      public RetrievalRerankAdvisor(org.springframework.ai.vectorstore.VectorStore vectorStore, RerankModel rerankModel, org.springframework.ai.vectorstore.SearchRequest searchRequest)

    • RetrievalRerankAdvisor

      public RetrievalRerankAdvisor(org.springframework.ai.vectorstore.VectorStore vectorStore, RerankModel rerankModel, org.springframework.ai.vectorstore.SearchRequest searchRequest, org.springframework.ai.chat.prompt.PromptTemplate promptTemplate, Double minScore)

    • RetrievalRerankAdvisor

      public RetrievalRerankAdvisor(org.springframework.ai.vectorstore.VectorStore vectorStore, RerankModel rerankModel, org.springframework.ai.vectorstore.SearchRequest searchRequest, org.springframework.ai.chat.prompt.PromptTemplate promptTemplate, Double minScore, int order)

  • Method Details

    • getOrder

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

    • doGetFilterExpression

      protected org.springframework.ai.vectorstore.filter.Filter.Expression doGetFilterExpression(Map<String,Object> context)

    • doRerank

      protected List<org.springframework.ai.document.Document> doRerank(org.springframework.ai.chat.client.ChatClientRequest request, List<org.springframework.ai.document.Document> documents)

    • before

      public org.springframework.ai.chat.client.ChatClientRequest before(org.springframework.ai.chat.client.ChatClientRequest request, 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, org.springframework.ai.chat.client.advisor.api.AdvisorChain advisorChain)
      Specified by:
      after in interface org.springframework.ai.chat.client.advisor.api.BaseAdvisor