Perform a search and return results that are reordered by MMR.
max_marginal_relevance_search(
self,
query: str,
k: int = 4,
fetch_k: int = 20,
lambda_mult: float = 0.5,
param: Optional[dict] = None,
expr: Optional[str] = None,
timeout: Optional[float] = None,
**kwargs: Any = {}
) -> List[Document]| Name | Type | Description |
|---|---|---|
query* | str | The text being searched. |
k | int | Default: 4How many results to give. Defaults to 4. |
fetch_k | int | Default: 20Total results to select k from. Defaults to 20. |
lambda_mult | float | Default: 0.5Number between 0 and 1 that determines the degree of diversity among the results with 0 corresponding to maximum diversity and 1 to minimum diversity. Defaults to 0.5 |
param | dict | Default: NoneThe search params for the specified index. Defaults to None. |
expr | str | Default: NoneFiltering expression. Defaults to None. |
timeout | float | Default: NoneHow long to wait before timeout error. Defaults to None. |
kwargs | Any | Default: {}Collection.search() keyword arguments. |