Method●Since v0.3

similaritySearch

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

similaritySearch(
  query: string,
  k: number,
  filter: string | object,
  callbacks: Callbacks
): Promise<DocumentInterface<Record<string, any>>[]>

Parameters

Name	Type	Description
`query`*	`string`	The text query to search for.
`k`	`number`	Optional number of similar documents to return.
`filter`	`string \| object`	Optional filter based on `FilterType` to restrict results.
`callbacks`	`Callbacks`	Optional callbacks for tracking progress or events during the search process.

View source on GitHub

similaritySearch

Parameters

LangChain Assistant

Menu

similaritySearch

Parameters