Method●Since v1.0

similaritySearch

Searches for documents similar to a text query by embedding the query and performing a similarity search on the resulting vector.

similaritySearch(
  query: string,
  k: number = 4,
  filter: (doc: Document) => boolean | undefined = undefined, _callbacks: Callbacks | undefined = undefined
): Promise<DocumentInterface<Record<string, any>>[]>

Parameters

Name	Type	Description
`query`*	`string`	Text query for finding similar documents.
`k`	`number`	Default:`4` Number of similar results to return. Defaults to 4.
`filter`	`(doc: Document) => boolean \| undefined`	Default:`undefined` Optional filter based on `FilterType`.
`_callbacks`	`Callbacks \| undefined`	Default:`undefined` Optional callbacks for monitoring search progress

View source on GitHub

similaritySearch

Parameters

LangChain Assistant

Menu

similaritySearch

Parameters