github/langchain
1
0
Fork 0
mirror of https://github.com/hwchase17/langchain.git synced 2025-06-25 08:03:39 +00:00
Code Issues Packages Projects Releases Wiki Activity

doc[Retriever] Enhance api docs for MultiQueryRetriever (#25035)

Browse Source 
Enhance api docs for `MultiQueryRetriever`:

- Complete missing parameters
- Unify parameter name
This commit is contained in:
ZhangShenao 2024-08-05 01:56:38 +08:00 committed by GitHub
parent 208042e0f2
commit 02c35da445
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 4 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
libs/langchain/langchain/retrievers/multi_query.py
View File

@ -72,6 +72,8 @@ class MultiQueryRetriever(BaseRetriever):
Args: Args:
retriever: retriever to query documents from retriever: retriever to query documents from
llm: llm for query generation using DEFAULT_QUERY_PROMPT llm: llm for query generation using DEFAULT_QUERY_PROMPT
prompt: The prompt which aims to generate several different versions
of the given user query
include_original: Whether to include the original query in the list of include_original: Whether to include the original query in the list of
generated queries. generated queries.
@ -95,7 +97,7 @@ class MultiQueryRetriever(BaseRetriever):
"""Get relevant documents given a user query. """Get relevant documents given a user query.
Args: Args:
question: user query query: user query
Returns: Returns:
Unique union of relevant documents from all generated queries Unique union of relevant documents from all generated queries
@ -158,7 +160,7 @@ class MultiQueryRetriever(BaseRetriever):
"""Get relevant documents given a user query. """Get relevant documents given a user query.
Args: Args:
question: user query query: user query
Returns: Returns:
Unique union of relevant documents from all generated queries Unique union of relevant documents from all generated queries