> For the complete documentation index, see [llms.txt](https://docs.raga.ai/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.raga.ai/ragaai-catalyst/ragaai-metric-library/guardrails/cosine-similarity.md).

# Cosine Similarity

**Objective**\
Measures the similarity between two pieces of text, ensuring consistency and relevance.

**Interpretation**\
A higher score typically means a higher degree of similarity (depending on implementation). A lower score indicates less similarity.

> *Implementation note*: Some may flip this scoring scale (i.e., 0 for identical texts and higher for differences). Ensure your usage matches your interpretation.

**Code Execution**

```python
metrics = [
    {
        "name": "Cosine Similarity",
        "config": {
            "model": "gpt-4o-mini",
            "provider": "openai"
        },
        "column_name": "your-column-identifier",
        "schema_mapping": schema_mapping
    }
]
```

**Example**

* **Prompt**: “Summarize the product description.”
* **Context**: “Product X is a portable charger with a 10000mAh battery.”
* **Response**: “Product X is a small device that charges phones and has a 10000mAh battery.”
* **Metric Output**: `{"score": 0.85, "reason": "High similarity to the context."}`


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.raga.ai/ragaai-catalyst/ragaai-metric-library/guardrails/cosine-similarity.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.