Skip to main content

​
find_most_similar

Method
This is a method of the EmbeddingAgent class in the embedding_agent module.
Find the most similar texts to a query.

​
Signature

def find_most_similar(query: str, candidates: List[str], top_k: int, model: Optional[str]) -> List[Dict[str, Any]]

​
Parameters

​
query
str
required
Query text
​
candidates
List
required
List of candidate texts to compare
​
top_k
int
default:"5"
Number of top results to return
​
model
Optional
Override model for this call **kwargs: Additional parameters

​
Returns

​
Returns
List[Dict[str, Any]]
List of dicts with ‘text’, ‘score’, and ‘index’ keys

​
Usage

agent = EmbeddingAgent()
    results = agent.find_most_similar(
        "What is AI?",
        ["Artificial intelligence is...", "Machine learning...", "Deep learning..."],
        top_k=2
    )
    for r in results:
        print(f"{r['score']:.2f}: {r['text'][:50]}...")