mirror of
				https://github.com/deepset-ai/haystack.git
				synced 2025-11-04 03:39:31 +00:00 
			
		
		
		
	* Add FilterRetriever draft * Implement FilterRetriever and add tests * Update comparison to compare whole docs instead of just contents * Expose FilterRetriever at the retrievers level * Update docstring (add example usage) * Add filter_retriever in the API reference docs config Update retriever search path to start one dir level higher * simplify _documents_equal * improve usage example --------- Co-authored-by: anakin87 <stefanofiorucci@gmail.com>
		
			
				
	
	
		
			32 lines
		
	
	
		
			925 B
		
	
	
	
		
			YAML
		
	
	
	
	
	
			
		
		
	
	
			32 lines
		
	
	
		
			925 B
		
	
	
	
		
			YAML
		
	
	
	
	
	
loaders:
 | 
						|
  - type: haystack_pydoc_tools.loaders.CustomPythonLoader
 | 
						|
    search_path: [../../../haystack/components/retrievers]
 | 
						|
    modules:
 | 
						|
      [
 | 
						|
        "in_memory/bm25_retriever",
 | 
						|
        "in_memory/embedding_retriever",
 | 
						|
        "filter_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.ReadmePreviewRenderer
 | 
						|
  excerpt: Sweeps through a Document Store and returns a set of candidate Documents that are relevant to the query.
 | 
						|
  category_slug: haystack-api
 | 
						|
  title: Retrievers
 | 
						|
  slug: retrievers-api
 | 
						|
  order: 130
 | 
						|
  markdown:
 | 
						|
    descriptive_class_title: false
 | 
						|
    descriptive_module_title: true
 | 
						|
    add_method_class_prefix: true
 | 
						|
    add_member_class_prefix: false
 | 
						|
    filename: retrievers_api.md
 |