Praison AI

similarity • AI Agent SDK

similarity: Calculate cosine similarity between two texts.

similarity

Method

</div>

This is a method of the EmbeddingAgent class in the embedding_agent module.

Calculate cosine similarity between two texts.

Signature

python
def similarity(text1: str, text2: str, model: Optional[str]) -> float

Parameters

ParamField str

First text

ParamField str

Second text

ParamField Optional[str]

Override model for this call **kwargs: Additional parameters

Returns

ResponseField float

Cosine similarity score (0.0 to 1.0)

Usage

python
agent = EmbeddingAgent()
    score = agent.similarity("Hello", "Hi there")
    print(f"Similarity: {score:.2f}")

Uses

  • embed_batch

Source

View on GitHub

praisonaiagents/agent/embedding_agent.py at line 265