Method●Since v0.3

similarity_search

Run a similarity search with Bagel.

similarity_search(
  self,
  query: str,
  k: int = DEFAULT_K,
  where: Optional[Dict[str, str]] = None,
  **kwargs: Any = {}
) -> List[Document]

Parameters

Name	Type	Description
`query`*	`str`	The query text to search for similar documents/texts.
`k`	`int`	Default:`DEFAULT_K` The number of results to return.
`where`	`Optional[Dict[str, str]]`	Default:`None` Metadata filters to narrow down.