Learn how to customize OpenSearchBM25Retriever.
YAML Init Parameters
These are the parameters you can pass to this component in the pipeline YAML configuration:
Parameter | Type | Possible values | Description |
---|---|---|---|
| OpenSearchDocumentStore | An instance of OpenSearchDocumentStore (DeepsetCloudDocumentStore). | |
| Dictionary of string and any | Default: | Filters applied to the retrieved documents. |
| String | Default: | Fuzziness parameter for full-text queries. To learn more about fuzziness, see Elastic documentation. |
| Integer | Default: | Maximum number of documents to return. |
| Boolean |
| Whether to scale the score of retrieved documents between 0 and 1. This is useful when comparing documents across different indexes. |
| Boolean |
| If |
| Union of string and FilterPolicy |
| Policy to determine how filters are applied. Possible values:
|
| Dictionary of string and any | Default: | Specifies the optional OpenSearch query to use for retrieving documents. |
| Boolean |
| Raises an exception if the API call fails. |
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.