Package org.springframework.ai.rag.preretrieval.query.expansion

Class MultiQueryExpander

java.lang.Object

org.springframework.ai.rag.preretrieval.query.expansion.MultiQueryExpander

All Implemented Interfaces:

Function<Query,List<Query>>, QueryExpander

public final class MultiQueryExpander
extends Object
implements QueryExpander

Uses a large language model to expand a query into multiple semantically diverse variations to capture different perspectives, useful for retrieving additional contextual information and increasing the chances of finding relevant results.

Example usage:

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

Since:

1.0.0

Author:

Thomas Vitale

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	MultiQueryExpander.Builder

Constructor Summary

Constructors

Constructor	Description
MultiQueryExpander(ChatClient.Builder chatClientBuilder, PromptTemplate promptTemplate, Boolean includeOriginal, Integer numberOfQueries)

Method Summary

Modifier and Type	Method	Description
static MultiQueryExpander.Builder	builder()
List<Query>	expand(Query query)	Expands the given query into a list of queries.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.function.Function

andThen, compose

Methods inherited from interface org.springframework.ai.rag.preretrieval.query.expansion.QueryExpander

apply

Constructor Details

MultiQueryExpander

public MultiQueryExpander(ChatClient.Builder chatClientBuilder,
 @Nullable
 PromptTemplate promptTemplate,
 @Nullable
 Boolean includeOriginal,
 @Nullable
 Integer numberOfQueries)

Method Details

expand

public List<Query> expand(Query query)

Description copied from interface: QueryExpander

Expands the given query into a list of queries.

Specified by:

expand in interface QueryExpander

Parameters:

query - The original query to be expanded

Returns:

A list of expanded queries

builder

public static MultiQueryExpander.Builder builder()