LangChain Reference home page

GitHub
Main Docs

Deep Agents Code

⌘I

LangChain Assistant

Ask a question to get started

Enter to send•Shift+Enter new line

Menu

Deep Agents Code

Language

Theme

Pythonlangchain-azure-postgresqllangchain_vectorstoreAzurePGVectorStoresimilarity_search

Method●Since v0.1

similarity_search

Copy

similarity_search(
  self,
  query: str,
  k: int = 4,
  **kwargs: Any

View source on GitHub

=

{

}

)

->

[

]

Similarity search for a query string using the configured index.

:param query: Query text to embed and search. :type query: str :param k: Number of most similar documents. :type k: int

Kwargs

filter: Filter | None; Optional filter to apply to the search.
top_m: int; Number of top results to prefetch when re-ranking (default: 5 * k).

:return: Top-k documents. :rtype: list[Document]