haystack/docs/_src/api/pydoc/retriever.yml
2022-10-20 15:07:48 +02:00

27 lines
820 B
YAML

loaders:
- type: python
search_path: [../../../../haystack/nodes/retriever]
modules: ['base', 'sparse', 'dense', 'text2sparql', 'multimodal/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.ReadmeRenderer
excerpt: Sweeps through a document store and returns a set of candidate documents that are relevant to the query.
category: 6310ca73c622850ddd3875a2
title: Retriever API
slug: retriever-api
order: 170
markdown:
descriptive_class_title: false
descriptive_module_title: true
add_method_class_prefix: true
add_member_class_prefix: false
filename: retriever_api.md