haystack/docs/pydoc/config_docusaurus/retrievers_api.yml

33 lines
983 B
YAML

loaders:
- type: haystack_pydoc_tools.loaders.CustomPythonLoader
search_path: [../../../haystack/components/retrievers]
modules:
[
"auto_merging_retriever",
"in_memory/bm25_retriever",
"in_memory/embedding_retriever",
"filter_retriever",
"sentence_window_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: haystack_pydoc_tools.renderers.DocusaurusRenderer
description: Sweeps through a Document Store and returns a set of candidate Documents that are relevant to the query.
title: Retrievers
id: retrievers-api
markdown:
descriptive_class_title: false
classdef_code_block: false
descriptive_module_title: true
add_method_class_prefix: true
add_member_class_prefix: false
filename: retrievers_api.md