Method●Since v0.3

similarity_search

Perform a similarity search using the given query.

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

Parameters

Name	Type	Description
`query`*	`str`	The query string.
`k`	`int`	Default:`4` The number of results to retrieve. Defaults to 4.
`filter`	`Optional[dict]`	Default:`None` A filter to apply to the search results.
`kwargs`	`Any`	Default:`{}` Additional keyword arguments.