haystack/docs/pydoc/config/retriever.yml
Massimiliano Pippi e1ec4e5e4d
refact!: Remove symbols under the haystack.document_stores namespace (#6714)
* remove symbols under the haystack.document_stores namespace

* Update haystack/document_stores/types/protocol.py

Co-authored-by: Silvano Cerza <3314350+silvanocerza@users.noreply.github.com>

* fix

* same for retrievers

* leftovers

* more leftovers

* add relnote

* leftovers

* one more

* fix examples

---------

Co-authored-by: Silvano Cerza <3314350+silvanocerza@users.noreply.github.com>
2024-01-10 21:20:42 +01:00

27 lines
819 B
YAML

loaders:
- type: loaders.CustomPythonLoader
search_path: [../../../haystack/components/retrievers/in_memory]
modules: ["bm25_retriever", "embedding_retriever"]
ignore_when_discovered: ["__init__"]
processors:
- type: filter
expression:
documented_only: true
do_not_filter_modules: false
skip_empty_modules: true
- type: smart
- type: crossref
renderer:
type: renderers.ReadmePreviewRenderer
excerpt: Sweeps through a Document Store and returns a set of candidate Documents that are relevant to the query.
category_slug: haystack-classes
title: Retriever API
slug: retriever-api
order: 130
markdown:
descriptive_class_title: false
descriptive_module_title: true
add_method_class_prefix: true
add_member_class_prefix: false
filename: retriever_api.md