Run similarity search.
similarity_search(
self,
query: str,
k: int = DEFAULT_TOP_K,
filter: Optional[Dict[str, Any]] = None,
brute_force: bool = False,
fraction_lists_to_search: Optional[float] = None,
**kwargs: Any = {}
) -> List[Document]| Name | Type | Description |
|---|---|---|
query* | str | search query text. |
k | int | Default: DEFAULT_TOP_KNumber of Documents to return. Defaults to 4. |
filter | Optional[Dict[str, Any]] | Default: NoneFilter on metadata properties, e.g. { "str_property": "foo", "int_property": 123 } |
brute_force | bool | Default: FalseWhether to use brute force search. Defaults to False. |
fraction_lists_to_search | Optional[float] | Default: NoneOptional percentage of lists to search, must be in range 0.0 and 1.0, exclusive. If Node, uses service's default which is 0.05. |