LangChain Reference home page

GitHub
Main Docs

LangChain

Browser
Universal
Hub
Node
Load
Serializable
Encoder Backed
File System
In Memory
Tools

LangChain Core

Text Splitters

MCP Adapters

⌘I

LangChain Assistant

Ask a question to get started

Enter to send•Shift+Enter new line

Menu

Browser Universal Hub Node Load Serializable Encoder Backed File System In Memory Tools

Agents Caches Base Dispatch Web Manager Promises Chat History Context Base Langsmith Documents Embeddings Errors Example Selectors Indexing Base Chat Models Compat Event Llms Openai Completions Stream Profile Stream Structured Output Load Serializable Memory Messages Tool Output Parsers Openai Functions Openai Tools Outputs Prompt Values Prompts Retrievers Document Compressors Runnables Graph Singletons Stores Structured Query Testing Tools Base Console Log Stream Run Collector Tracer Langchain Stream Async Caller Chunk Array Context Env Event Source Parse Format Function Calling Hash Json Patch Json Schema Math Ssrf Standard Schema Stream Testing Tiktoken Types Uuid Vectorstores

Language

Theme

JavaScript@langchain/corevectorstoresVectorStoreInterfacesimilaritySearch

Method●Since v0.3

similaritySearch

Copy

similaritySearch(
  query: string,
  k: number,
  filter: string | object,
  callbacks: Callbacks
): Promise

View source on GitHub

<

DocumentInterface

<

<

string

,

any

>

>

[

]

>

Parameters

Name	Type	Description
`query`*	`string`
`k`	`number`
`filter`	`string \| object`
`callbacks`	`Callbacks`

Searches for documents similar to a text query, embedding the query and retrieving documents based on vector similarity.

The text query to search for.

Optional number of similar documents to return.

Optional filter based on FilterType to restrict results.

Optional callbacks for tracking progress or events during the search process.