langchain Architecture Docs
Home / Function/ _aget_relevant_documents() — langchain Function Reference

_aget_relevant_documents() — langchain Function Reference

Architecture documentation for the _aget_relevant_documents() function in base.py from the langchain codebase.

Function python DataProcessing TextSplitters calls 3

Entity Profile

Dependency Diagram

graph TD
  b39b9863_1373_282b_c5cb_bebb545f3276["_aget_relevant_documents()"]
  0ab16606_6f12_fe39_c02a_5f20541c161f["VectorStoreRetriever"]
  b39b9863_1373_282b_c5cb_bebb545f3276 -->|defined in| 0ab16606_6f12_fe39_c02a_5f20541c161f
  41bbebb1_b0af_d870_c2bd_efa10cfe64d0["asimilarity_search()"]
  b39b9863_1373_282b_c5cb_bebb545f3276 -->|calls| 41bbebb1_b0af_d870_c2bd_efa10cfe64d0
  9136aa9f_d720_ee5b_3f80_83c18d3e014d["asimilarity_search_with_relevance_scores()"]
  b39b9863_1373_282b_c5cb_bebb545f3276 -->|calls| 9136aa9f_d720_ee5b_3f80_83c18d3e014d
  efca5a17_7174_3316_46ec_3b51abde1db2["amax_marginal_relevance_search()"]
  b39b9863_1373_282b_c5cb_bebb545f3276 -->|calls| efca5a17_7174_3316_46ec_3b51abde1db2
  style b39b9863_1373_282b_c5cb_bebb545f3276 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

libs/core/langchain_core/vectorstores/base.py lines 1061–1085

    async def _aget_relevant_documents(
        self,
        query: str,
        *,
        run_manager: AsyncCallbackManagerForRetrieverRun,
        **kwargs: Any,
    ) -> list[Document]:
        kwargs_ = self.search_kwargs | kwargs
        if self.search_type == "similarity":
            docs = await self.vectorstore.asimilarity_search(query, **kwargs_)
        elif self.search_type == "similarity_score_threshold":
            docs_and_similarities = (
                await self.vectorstore.asimilarity_search_with_relevance_scores(
                    query, **kwargs_
                )
            )
            docs = [doc for doc, _ in docs_and_similarities]
        elif self.search_type == "mmr":
            docs = await self.vectorstore.amax_marginal_relevance_search(
                query, **kwargs_
            )
        else:
            msg = f"search_type of {self.search_type} not allowed."
            raise ValueError(msg)
        return docs

Domain

Subdomains

Defined In

Calls

Source

Frequently Asked Questions

What does _aget_relevant_documents() do?
_aget_relevant_documents() is a function in the langchain codebase, defined in libs/core/langchain_core/vectorstores/base.py.
Where is _aget_relevant_documents() defined?
_aget_relevant_documents() is defined in libs/core/langchain_core/vectorstores/base.py at line 1061.
What does _aget_relevant_documents() call?
_aget_relevant_documents() calls 3 function(s): amax_marginal_relevance_search, asimilarity_search, asimilarity_search_with_relevance_scores.

Analyze Your Own Codebase

Get architecture documentation, dependency graphs, and domain analysis for your codebase in minutes.

Try Supermodel Free