FilterRetriever

Retrieves documents that match the provided filters.

Basic Information

• Type: haystack_integrations.retrievers.filter_retriever.FilterRetriever

Inputs

Parameter	Type	Default	Description
filters	Optional[Dict[str, Any]]	None	A dictionary with filters to narrow down the search space. If not specified, the FilterRetriever uses the values provided at initialization.

Outputs

Parameter	Type	Default	Description
documents	List[Document]		A list of retrieved documents.

Overview

Work in Progress

Bear with us while we're working on adding pipeline examples and most common components connections.

Retrieves documents that match the provided filters.

Usage Example

components:
  FilterRetriever:
    type: components.retrievers.filter_retriever.FilterRetriever
    init_parameters:

Parameters

Init Parameters

These are the parameters you can configure in Pipeline Builder:

Parameter	Type	Default	Description
document_store	DocumentStore		An instance of a Document Store to use with the Retriever.
filters	Optional[Dict[str, Any]]	None	A dictionary with filters to narrow down the search space.

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
filters	Optional[Dict[str, Any]]	None	A dictionary with filters to narrow down the search space. If not specified, the FilterRetriever uses the values provided at initialization.