# Prompt-response Similarity

This module is designed to scan a prompt and that prompts response from an LLM to determine how semantically similar they are. Embeddings are generated for the prompt and response then the cosine similarity is returned.  

This scanner must be enabled in the `output_scanners` section of the `conf/server.conf` configuration file, and it uses a different method of calling than the normal input scanners.

**API endpoint**\
POST */analyze/response*

```json
{
    "prompt": str,
    "response": str
}
```


---

# Agent Instructions: 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:

```
GET https://vigil.deadbits.ai/overview/use-vigil/scanners/prompt-response-similarity.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
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.