MultiQueryTextRetriever
Retrieve documents using multiple text queries in parallel with a text-based retriever. It improves recall by finding documents relevant to multiple query variations simultaneously, which is especially useful with BM25 keyword search.
Key Features
- Processes multiple queries in parallel using a thread pool.
- Works with any text-based retriever, including BM25 retrievers.
- Combines results from all queries, deduplicates by content, and sorts by relevance score.
- Works best with
QueryExpanderto generate semantically similar query variations. - Useful when documents use different words than user queries.
Configuration
- Drag the
MultiQueryTextRetrievercomponent onto the canvas from the Component Library. - Click the component to open the configuration panel.
- On the General tab:
- Select the text-based retriever to use for document retrieval.
- Go to the Advanced tab to configure
max_workersfor parallel processing.
Connections
MultiQueryTextRetriever accepts a list of queries (strings) and an optional retriever_kwargs dictionary as inputs. It outputs documents — a deduplicated, relevance-sorted list of retrieved documents.
Typically, you connect QueryExpander to the queries input to provide expanded query variations. Send the documents output to a Ranker or DocumentJoiner for further processing.
Usage Example
This example shows how to perform retrieval with QueryExpander and MultiQueryTextRetriever. You can then send the retrieved documents to a Ranker or DocumentJoiner component to combine the results:
components:
query_expander:
type: haystack.components.query.query_expander.QueryExpander
init_parameters:
n_expansions: 3
include_original_query: true
chat_generator:
type: haystack_integrations.components.generators.anthropic.chat.chat_generator.AnthropicChatGenerator
init_parameters: {}
multi_query_retriever:
type: haystack.components.retrievers.multi_query_embedding_retriever.MultiQueryEmbeddingRetriever
init_parameters:
query_embedder:
type: haystack.components.embedders.sentence_transformers_text_embedder.SentenceTransformersTextEmbedder
init_parameters:
model: sentence-transformers/all-MiniLM-L6-v2
retriever:
type: haystack_integrations.components.retrievers.opensearch.embedding_retriever.OpenSearchEmbeddingRetriever
init_parameters:
document_store:
type: haystack_integrations.document_stores.opensearch.document_store.OpenSearchDocumentStore
top_k: 5
max_workers: 3
connections:
- sender: query_expander.queries
receiver: multi_query_retriever.queries
max_runs_per_component: 100
metadata: {}
inputs:
query:
- query_expander.query
Parameters
Inputs
| Parameter | Type | Description |
|---|---|---|
queries | List[str] | List of text queries to process. |
retriever_kwargs | Optional[Dict[str, Any]] | Optional dictionary of arguments to pass to the retriever's run method. |
Outputs
| Parameter | Type | Description |
|---|---|---|
documents | List[Document] | List of retrieved documents sorted by relevance score, deduplicated by content. |
Init Parameters
These are the parameters you can configure in Pipeline Builder:
| Parameter | Type | Default | Description |
|---|---|---|---|
retriever | TextRetriever | The text-based retriever to use for document retrieval. Must implement the TextRetriever protocol. | |
max_workers | int | three | Maximum number of worker threads for parallel processing. |
Run Method Parameters
These are the parameters you can configure for the component's run() method. This means you can pass these parameters at query time through the API, in Playground, or when running a job. For details, see Modify Pipeline Parameters at Query Time.
| Parameter | Type | Default | Description |
|---|---|---|---|
queries | List[str] | List of text queries to process. | |
retriever_kwargs | Optional[Dict[str, Any]] | None | Optional dictionary of arguments to pass to the retriever's run method (for example, filters, top_k). |
Was this page helpful?