FilterRetriever Parameters

Learn how to customize FilterRetriever.

YAML Init Parameters

These are the parameters you can pass to this component in the pipeline YAML configuration:

Parameter

Type

Possible values

Description

document_store

DocumentStore

An instance of a DocumentStore from which the retriever should fetch documents.
Required.

filters

Dictionary of string and any

Default: None

A dictionary with filters to narrow down the search space. For information on filter syntax, see Filtering Logic.
Optional.


REST API Runtime Parameters

There are no runtime parameters you can pass to this component when making a request to the Search REST API endpoint.