Function●Since v0.1

maximal_marginal_relevance

Calculate maximal marginal relevance.

maximal_marginal_relevance(
  query_embedding: np.ndarray,
  embedding_list: list,
  lambda_mult: float = 0.5,
  k: int = 4
) -> list[int]

Parameters

Name	Type	Description
`query_embedding`*	`np.ndarray`	Query embedding.
`embedding_list`*	`list`	List of embeddings to select from.
`lambda_mult`	`float`	Default:`0.5` Number between `0` and `1` that determines the degree of diversity among the results with `0` corresponding to maximum diversity and `1` to minimum diversity.
`k`	`int`	Default:`4` Number of Documents to return.