Method●Since v1.0

similaritySearch

Return documents that are most similar to the query.

similaritySearch(
  query: string,
  k: number = 4,
  filter: CouchbaseSearchVectorStoreFilter = {}
): Promise<Document<Record<string, any>>[]>

Parameters

Name	Type	Description
`query`*	`string`	Query to look up for similar documents
`k`	`number`	Default:`4` The number of similar documents to return. Defaults to 4.
`filter`	`CouchbaseSearchVectorStoreFilter`	Default:`{}` Optional search filter that are passed to Couchbase search. Defaults to empty object. `fields`: Optional list of fields to include in the metadata of results. Note that these need to be stored in the index. If nothing is specified, defaults to all the fields stored in the index. `searchOptions`: Optional search options that are passed to Couchbase search. Defaults to empty object.