yujunjun/haystack
1
0
Fork 0
mirror of https://github.com/deepset-ai/haystack.git synced 2025-12-27 06:58:35 +00:00
Code Issues Packages Projects Releases Wiki Activity

fix: update WebRetriever docstrings and default mode (#5352)

Browse Source 
* update WebRetriever docstrings

* snippets as default mode
This commit is contained in:
Daria Fokina 2023-07-13 13:57:52 +02:00 committed by GitHub
parent f21005f8ea
commit 63fd63ff23
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 4 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
haystack/nodes/retriever/web.py
View File

@ -67,8 +67,11 @@ class WebRetriever(BaseRetriever):
cache_time: int = 1 * 24 * 60 * 60,
):
"""
:param api_key: API key for the search engine provider.
:param search_engine_provider: Name of the search engine provider class, see `providers.py` for a list of supported providers.
:param top_search_results: Number of top search results to be retrieved.
:param top_k: Top k documents to be returned by the retriever.
:param mode: Whether to return snippets, raw documents, or preprocessed documents. Preprocessed documents are the default.
:param mode: Whether to return snippets, raw documents, or preprocessed documents. Snippets are the default.
:param preprocessor: Optional PreProcessor to be used to split documents into paragraphs. If not provided, the default PreProcessor is used.
:param cache_document_store: DocumentStore to be used to cache search results.
:param cache_index: Index name to be used to cache search results.