检索增强生成

检索增强生成（RAG）是一种技术，用于克服大型语言模型在处理长篇内容、事实准确性和上下文感知方面遇到的局限性。

Spring AI 通过提供模块化架构来支持 RAG，该架构允许您自行构建自定义 RAG 流程，或使用 Advisor API 使用开箱即用的 RAG 流程。

在概念部分了解更多关于检索增强生成的信息。

Advisors

Spring AI 使用 Advisor API 为常见的 RAG 流程提供开箱即用的支持。

要使用 QuestionAnswerAdvisor 或 RetrievalAugmentationAdvisor，您需要将 spring-ai-advisors-vector-store 依赖项添加到您的项目中

<dependency>
   <groupId>org.springframework.ai</groupId>
   <artifactId>spring-ai-advisors-vector-store</artifactId>
</dependency>

QuestionAnswerAdvisor

向量数据库存储 AI 模型不知道的数据。当用户问题发送到 AI 模型时，QuestionAnswerAdvisor 查询向量数据库以获取与用户问题相关的文档。

向量数据库的响应被附加到用户文本中，为 AI 模型生成响应提供上下文。

假设您已将数据加载到 VectorStore 中，您可以通过向 ChatClient 提供一个 QuestionAnswerAdvisor 实例来执行检索增强生成 (RAG)。

ChatResponse response = ChatClient.builder(chatModel)
        .build().prompt()
        .advisors(new QuestionAnswerAdvisor(vectorStore))
        .user(userText)
        .call()
        .chatResponse();

在此示例中，QuestionAnswerAdvisor 将对向量数据库中的所有文档执行相似度搜索。为了限制搜索的文档类型，SearchRequest 接受类似 SQL 的过滤表达式，该表达式可在所有 VectorStore 中移植。

此过滤表达式可以在创建 QuestionAnswerAdvisor 时配置，因此将始终应用于所有 ChatClient 请求，或者可以在运行时按请求提供。

以下是如何创建一个 QuestionAnswerAdvisor 实例，其中阈值为 0.8 并返回前 6 个结果。

var qaAdvisor = QuestionAnswerAdvisor.builder(vectorStore)
        .searchRequest(SearchRequest.builder().similarityThreshold(0.8d).topK(6).build())
        .build();

动态过滤表达式

使用 FILTER_EXPRESSION advisor 上下文参数在运行时更新 SearchRequest 过滤表达式

ChatClient chatClient = ChatClient.builder(chatModel)
    .defaultAdvisors(QuestionAnswerAdvisor.builder(vectorStore)
        .searchRequest(SearchRequest.builder().build())
        .build())
    .build();

// Update filter expression at runtime
String content = this.chatClient.prompt()
    .user("Please answer my question XYZ")
    .advisors(a -> a.param(QuestionAnswerAdvisor.FILTER_EXPRESSION, "type == 'Spring'"))
    .call()
    .content();

FILTER_EXPRESSION 参数允许您根据提供的表达式动态过滤搜索结果。

自定义模板

QuestionAnswerAdvisor 使用默认模板用检索到的文档增强用户问题。您可以通过 .promptTemplate() builder 方法提供自己的 PromptTemplate 对象来定制此行为。

此处提供的 PromptTemplate 定制了 advisor 如何将检索到的上下文与用户查询合并。这与在 ChatClient 本身（使用 .templateRenderer()）上配置 TemplateRenderer 不同，后者影响 advisor 运行之前的初始用户/系统提示内容渲染。有关客户端级别模板渲染的更多详细信息，请参见ChatClient 提示词模板。

自定义 PromptTemplate 可以使用任何 TemplateRenderer 实现（默认情况下，它使用基于 StringTemplate 引擎的 StPromptTemplate）。重要的要求是模板必须包含一个占位符来接收检索到的上下文，advisor 在键 question_answer_context 下提供此上下文。

PromptTemplate customPromptTemplate = PromptTemplate.builder()
    .renderer(StTemplateRenderer.builder().startDelimiterToken('<').endDelimiterToken('>').build())
    .template("""
            Context information is below.

			---------------------
			<question_answer_context>
			---------------------

			Given the context information and no prior knowledge, answer the query.

			Follow these rules:

			1. If the answer is not in the context, just say that you don't know.
			2. Avoid statements like "Based on the context..." or "The provided information...".
            """)
    .build();

    String question = "Where does the adventure of Anacletus and Birba take place?";

    QuestionAnswerAdvisor qaAdvisor = QuestionAnswerAdvisor.builder(vectorStore)
        .promptTemplate(customPromptTemplate)
        .build();

    String response = ChatClient.builder(chatModel).build()
        .prompt(question)
        .advisors(qaAdvisor)
        .call()
        .content();

建议使用 .promptTemplate() 进行更灵活的定制，而不是使用已弃用的 QuestionAnswerAdvisor.Builder.userTextAdvise() 方法。

RetrievalAugmentationAdvisor (孵化中)

Spring AI 包含一个RAG 模块库，您可以使用它来构建自己的 RAG 流程。RetrievalAugmentationAdvisor 是一个 Advisor，它基于模块化架构，为最常见的 RAG 流程提供开箱即用的实现。

顺序 RAG 流程

朴素 RAG

Advisor retrievalAugmentationAdvisor = RetrievalAugmentationAdvisor.builder()
        .documentRetriever(VectorStoreDocumentRetriever.builder()
                .similarityThreshold(0.50)
                .vectorStore(vectorStore)
                .build())
        .build();

String answer = chatClient.prompt()
        .advisors(retrievalAugmentationAdvisor)
        .user(question)
        .call()
        .content();

默认情况下，RetrievalAugmentationAdvisor 不允许检索到的上下文为空。发生这种情况时，它会指示模型不回答用户查询。您可以按如下方式允许空上下文。

Advisor retrievalAugmentationAdvisor = RetrievalAugmentationAdvisor.builder()
        .documentRetriever(VectorStoreDocumentRetriever.builder()
                .similarityThreshold(0.50)
                .vectorStore(vectorStore)
                .build())
        .queryAugmenter(ContextualQueryAugmenter.builder()
                .allowEmptyContext(true)
                .build())
        .build();

String answer = chatClient.prompt()
        .advisors(retrievalAugmentationAdvisor)
        .user(question)
        .call()
        .content();

VectorStoreDocumentRetriever 接受一个 FilterExpression，用于根据元数据过滤搜索结果。您可以在实例化 VectorStoreDocumentRetriever 时或在运行时按请求提供，使用 FILTER_EXPRESSION advisor 上下文参数。

Advisor retrievalAugmentationAdvisor = RetrievalAugmentationAdvisor.builder()
        .documentRetriever(VectorStoreDocumentRetriever.builder()
                .similarityThreshold(0.50)
                .vectorStore(vectorStore)
                .build())
        .build();

String answer = chatClient.prompt()
        .advisors(retrievalAugmentationAdvisor)
        .advisors(a -> a.param(VectorStoreDocumentRetriever.FILTER_EXPRESSION, "type == 'Spring'"))
        .user(question)
        .call()
        .content();

有关详细信息，请参见VectorStoreDocumentRetriever。

高级 RAG

Advisor retrievalAugmentationAdvisor = RetrievalAugmentationAdvisor.builder()
        .queryTransformers(RewriteQueryTransformer.builder()
                .chatClientBuilder(chatClientBuilder.build().mutate())
                .build())
        .documentRetriever(VectorStoreDocumentRetriever.builder()
                .similarityThreshold(0.50)
                .vectorStore(vectorStore)
                .build())
        .build();

String answer = chatClient.prompt()
        .advisors(retrievalAugmentationAdvisor)
        .user(question)
        .call()
        .content();

模块

Spring AI 实现了一种模块化 RAG 架构，其灵感来自于论文 "Modular RAG: Transforming RAG Systems into LEGO-like Reconfigurable Frameworks" 中详细阐述的模块化概念。

检索前

检索前模块负责处理用户查询，以获得最佳的检索结果。

查询转换

用于转换输入查询以使其更有效地执行检索任务的组件，解决诸如格式不规范的查询、歧义术语、复杂词汇或不支持的语言等挑战。

使用 QueryTransformer 时，建议将 ChatClient.Builder 配置为低温（例如 0.0），以确保更确定性和准确的结果，从而提高检索质量。大多数聊天模型的默认温度对于最优的查询转换来说通常过高，会导致检索效果降低。

CompressionQueryTransformer

CompressionQueryTransformer 使用大型语言模型将对话历史和后续查询压缩成一个独立的查询，该查询捕获了对话的精髓。

当对话历史很长且后续查询与对话上下文相关时，此转换器非常有用。

Query query = Query.builder()
        .text("And what is its second largest city?")
        .history(new UserMessage("What is the capital of Denmark?"),
                new AssistantMessage("Copenhagen is the capital of Denmark."))
        .build();

QueryTransformer queryTransformer = CompressionQueryTransformer.builder()
        .chatClientBuilder(chatClientBuilder)
        .build();

Query transformedQuery = queryTransformer.transform(query);

此组件使用的提示词可以通过 builder 中提供的 promptTemplate() 方法进行定制。

RewriteQueryTransformer

RewriteQueryTransformer 使用大型语言模型重写用户查询，以便在查询目标系统（如向量存储或网络搜索引擎）时提供更好的结果。

当用户查询冗长、模糊或包含可能影响搜索结果质量的不相关信息时，此转换器非常有用。

Query query = new Query("I'm studying machine learning. What is an LLM?");

QueryTransformer queryTransformer = RewriteQueryTransformer.builder()
        .chatClientBuilder(chatClientBuilder)
        .build();

Query transformedQuery = queryTransformer.transform(query);

此组件使用的提示词可以通过 builder 中提供的 promptTemplate() 方法进行定制。

TranslationQueryTransformer

TranslationQueryTransformer 使用大型语言模型将查询翻译成目标语言，该目标语言由用于生成文档嵌入的嵌入模型支持。如果查询已经处于目标语言，则原样返回。如果查询的语言未知，也原样返回。

当嵌入模型在一个特定语言上训练而用户查询在另一个不同语言时，此转换器非常有用。

Query query = new Query("Hvad er Danmarks hovedstad?");

QueryTransformer queryTransformer = TranslationQueryTransformer.builder()
        .chatClientBuilder(chatClientBuilder)
        .targetLanguage("english")
        .build();

Query transformedQuery = queryTransformer.transform(query);

此组件使用的提示词可以通过 builder 中提供的 promptTemplate() 方法进行定制。

查询扩展

将输入查询扩展为查询列表的组件，通过提供替代查询表述或将复杂问题分解为更简单的子查询来解决诸如格式不规范的查询等挑战。

MultiQueryExpander

MultiQueryExpander 使用大型语言模型将一个查询扩展为多个语义上不同的变体，以捕捉不同的视角，有助于检索额外的上下文信息并增加找到相关结果的机会。

MultiQueryExpander queryExpander = MultiQueryExpander.builder()
    .chatClientBuilder(chatClientBuilder)
    .numberOfQueries(3)
    .build();
List<Query> queries = queryExpander.expand(new Query("How to run a Spring Boot app?"));

默认情况下，MultiQueryExpander 在扩展查询列表中包含原始查询。您可以通过 builder 中的 includeOriginal 方法禁用此行为。

MultiQueryExpander queryExpander = MultiQueryExpander.builder()
    .chatClientBuilder(chatClientBuilder)
    .includeOriginal(false)
    .build();

此组件使用的提示词可以通过 builder 中提供的 promptTemplate() 方法进行定制。

检索

检索模块负责查询数据系统（如向量存储）并检索最相关的文档。

文档搜索

负责从底层数据源（如搜索引擎、向量存储、数据库或知识图谱）检索 Documents 的组件。

VectorStoreDocumentRetriever

VectorStoreDocumentRetriever 从向量存储中检索与输入查询在语义上相似的文档。它支持基于元数据、相似度阈值和 top-k 结果的过滤。

DocumentRetriever retriever = VectorStoreDocumentRetriever.builder()
    .vectorStore(vectorStore)
    .similarityThreshold(0.73)
    .topK(5)
    .filterExpression(new FilterExpressionBuilder()
        .eq("genre", "fairytale")
        .build())
    .build();
List<Document> documents = retriever.retrieve(new Query("What is the main character of the story?"));

过滤表达式可以是静态的或动态的。对于动态过滤表达式，您可以传递一个 Supplier。

DocumentRetriever retriever = VectorStoreDocumentRetriever.builder()
    .vectorStore(vectorStore)
    .filterExpression(() -> new FilterExpressionBuilder()
        .eq("tenant", TenantContextHolder.getTenantIdentifier())
        .build())
    .build();
List<Document> documents = retriever.retrieve(new Query("What are the KPIs for the next semester?"));

您还可以通过 Query API，使用 FILTER_EXPRESSION 参数提供特定于请求的过滤表达式。如果同时提供了特定于请求和特定于检索器的过滤表达式，则特定于请求的过滤表达式优先。

Query query = Query.builder()
    .text("Who is Anacletus?")
    .context(Map.of(VectorStoreDocumentRetriever.FILTER_EXPRESSION, "location == 'Whispering Woods'"))
    .build();
List<Document> retrievedDocuments = documentRetriever.retrieve(query);

文档合并

用于将基于多个查询和来自多个数据源检索到的文档合并为一个文档集合的组件。作为合并过程的一部分，它还可以处理重复文档和倒数排序策略。

ConcatenationDocumentJoiner

ConcatenationDocumentJoiner 通过将基于多个查询和来自多个数据源检索到的文档串联起来，将它们合并成一个文档集合。如果存在重复文档，则保留第一次出现。每个文档的分数保持不变。

Map<Query, List<List<Document>>> documentsForQuery = ...
DocumentJoiner documentJoiner = new ConcatenationDocumentJoiner();
List<Document> documents = documentJoiner.join(documentsForQuery);

检索后

检索后模块负责处理检索到的文档，以获得最佳的生成结果。

文档后处理

用于根据查询对检索到的文档进行后处理的组件，解决诸如中间遗失、模型上下文长度限制以及减少检索信息中的噪声和冗余的需求等挑战。

例如，它可以根据文档与查询的相关性进行排名，删除不相关或冗余的文档，或压缩每个文档的内容以减少噪声和冗余。

生成

生成模块负责根据用户查询和检索到的文档生成最终响应。

查询增强

用于使用附加数据增强输入查询的组件，有助于为大型语言模型提供回答用户查询所需的上下文。

ContextualQueryAugmenter

ContextualQueryAugmenter 使用所提供文档内容中的上下文数据增强用户查询。

QueryAugmenter queryAugmenter = ContextualQueryAugmenter.builder().build();

默认情况下，ContextualQueryAugmenter 不允许检索到的上下文为空。发生这种情况时，它会指示模型不回答用户查询。

您可以启用 allowEmptyContext 选项，即使检索到的上下文为空，也允许模型生成响应。

QueryAugmenter queryAugmenter = ContextualQueryAugmenter.builder()
        .allowEmptyContext(true)
        .build();

此组件使用的提示词可以通过 builder 中提供的 promptTemplate() 和 emptyContextPromptTemplate() 方法进行定制。