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

similarity_search() — langchain Function Reference

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

Function python DataProcessing VectorStores called by 2

Entity Profile

Dependency Diagram

graph TD
  b807f806_ea44_9207_6e3f_cb2be8d2e638["similarity_search()"]
  6c336ac6_f55c_1ad7_6db3_73dbd71fb625["VectorStore"]
  b807f806_ea44_9207_6e3f_cb2be8d2e638 -->|defined in| 6c336ac6_f55c_1ad7_6db3_73dbd71fb625
  bacd4785_4aaa_2a48_7d2a_aaff3f343f40["search()"]
  bacd4785_4aaa_2a48_7d2a_aaff3f343f40 -->|calls| b807f806_ea44_9207_6e3f_cb2be8d2e638
  c524ddff_060d_d388_e89e_f62f4a167558["_get_relevant_documents()"]
  c524ddff_060d_d388_e89e_f62f4a167558 -->|calls| b807f806_ea44_9207_6e3f_cb2be8d2e638
  style b807f806_ea44_9207_6e3f_cb2be8d2e638 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

libs/core/langchain_core/vectorstores/base.py lines 361–373

    def similarity_search(
        self, query: str, k: int = 4, **kwargs: Any
    ) -> list[Document]:
        """Return docs most similar to query.

        Args:
            query: Input text.
            k: Number of `Document` objects to return.
            **kwargs: Arguments to pass to the search method.

        Returns:
            List of `Document` objects most similar to the query.
        """

Domain

Subdomains

Defined In

Called By

Source

Frequently Asked Questions

What does similarity_search() do?
similarity_search() is a function in the langchain codebase, defined in libs/core/langchain_core/vectorstores/base.py.
Where is similarity_search() defined?
similarity_search() is defined in libs/core/langchain_core/vectorstores/base.py at line 361.
What calls similarity_search()?
similarity_search() is called by 2 function(s): _get_relevant_documents, search.

Analyze Your Own Codebase

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

Try Supermodel Free