Skip to content

Commit

Permalink
doc[Retriever] Enhance api docs for MultiQueryRetriever (langchain-…
Browse files Browse the repository at this point in the history
…ai#25035)

Enhance api docs for `MultiQueryRetriever`:

- Complete missing parameters
- Unify parameter name
  • Loading branch information
ZhangShenao authored Aug 4, 2024
1 parent 208042e commit 02c35da
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions libs/langchain/langchain/retrievers/multi_query.py
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,8 @@ def from_llm(
Args:
retriever: retriever to query documents from
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
generated queries.
Expand All @@ -95,7 +97,7 @@ async def _aget_relevant_documents(
"""Get relevant documents given a user query.
Args:
question: user query
query: user query
Returns:
Unique union of relevant documents from all generated queries
Expand Down Expand Up @@ -158,7 +160,7 @@ def _get_relevant_documents(
"""Get relevant documents given a user query.
Args:
question: user query
query: user query
Returns:
Unique union of relevant documents from all generated queries
Expand Down

0 comments on commit 02c35da

Please sign in to comment.