| Name | Type | Description |
|---|---|---|
query_embedding* | np.ndarray | Embedding of the query text. |
embedding_list* | List[np.ndarray] | List of embeddings to select from. |
lambda_mult | float | Default: 0.5Number between |
k | int | Default: 4 |
Calculate maximal marginal relevance.
Maximal marginal relevance optimizes for similarity to the query AND diversity among selected documents.
Example:
from langchain_redis.vectorstores import maximal_marginal_relevance
from langchain_openai import OpenAIEmbeddings
import numpy as np
embeddings = OpenAIEmbeddings()
query = "What is the capital of France?"
query_embedding = embeddings.embed_query(query)
documents = [
"Paris is the capital of France.",
"France's capital city is Paris.",
"Berlin is the capital of Germany.",
]
doc_embeddings = embeddings.embed_documents(documents)
selected_indices = maximal_marginal_relevance(
query_embedding=np.array(query_embedding),
embedding_list=[np.array(emb) for emb in doc_embeddings],
lambda_mult=0.5,
k=2
)
for idx in selected_indices:
print(f"Selected document: {documents[idx]}")Number of results to return.