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

_get_relevant_documents() — langchain Function Reference

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

Function python DataProcessing TextSplitters calls 3

Entity Profile

Dependency Diagram

graph TD
  c524ddff_060d_d388_e89e_f62f4a167558["_get_relevant_documents()"]
  0ab16606_6f12_fe39_c02a_5f20541c161f["VectorStoreRetriever"]
  c524ddff_060d_d388_e89e_f62f4a167558 -->|defined in| 0ab16606_6f12_fe39_c02a_5f20541c161f
  b807f806_ea44_9207_6e3f_cb2be8d2e638["similarity_search()"]
  c524ddff_060d_d388_e89e_f62f4a167558 -->|calls| b807f806_ea44_9207_6e3f_cb2be8d2e638
  42fc6116_575b_3b3d_aef3_7429e8fbe07e["similarity_search_with_relevance_scores()"]
  c524ddff_060d_d388_e89e_f62f4a167558 -->|calls| 42fc6116_575b_3b3d_aef3_7429e8fbe07e
  e6447f07_ba7b_8372_40bb_6d29265eb1a8["max_marginal_relevance_search()"]
  c524ddff_060d_d388_e89e_f62f4a167558 -->|calls| e6447f07_ba7b_8372_40bb_6d29265eb1a8
  style c524ddff_060d_d388_e89e_f62f4a167558 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

libs/core/langchain_core/vectorstores/base.py lines 1040–1058

    def _get_relevant_documents(
        self, query: str, *, run_manager: CallbackManagerForRetrieverRun, **kwargs: Any
    ) -> list[Document]:
        kwargs_ = self.search_kwargs | kwargs
        if self.search_type == "similarity":
            docs = self.vectorstore.similarity_search(query, **kwargs_)
        elif self.search_type == "similarity_score_threshold":
            docs_and_similarities = (
                self.vectorstore.similarity_search_with_relevance_scores(
                    query, **kwargs_
                )
            )
            docs = [doc for doc, _ in docs_and_similarities]
        elif self.search_type == "mmr":
            docs = self.vectorstore.max_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 _get_relevant_documents() do?
_get_relevant_documents() is a function in the langchain codebase, defined in libs/core/langchain_core/vectorstores/base.py.
Where is _get_relevant_documents() defined?
_get_relevant_documents() is defined in libs/core/langchain_core/vectorstores/base.py at line 1040.
What does _get_relevant_documents() call?
_get_relevant_documents() calls 3 function(s): max_marginal_relevance_search, similarity_search, similarity_search_with_relevance_scores.

Analyze Your Own Codebase

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

Try Supermodel Free