> For the complete documentation index, see [llms.txt](https://docs.avoautomation.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.avoautomation.com/avo-assure/actions/generic/file-and-folder-operations/get-image-similarity-percentage.md).

# Get Image Similarity Percentage

This is pre-built Action located under the **@Generic Element**, instructs the Avo Assure to retrieve the similarity of the two Images in Percentage whose image path is provided in the input field and save the result in the dynamic variable.

### **Syntax**

**Input Value:** `<image1path>;<image2path>`

| Argument                              | Description                                                                                         |
| ------------------------------------- | --------------------------------------------------------------------------------------------------- |
| <p>\<image1path></p><p>(Required)</p> | Provide the image path to be compared with the second image to calculate the similarity percentage. |
| <p>\<image2path><br>(Required)</p>    | Provide the image path to be compared with the first Image to calculate the similarity percentage.  |

**Output Value:**

| Argument                                 | Description                                                                                  |
| ---------------------------------------- | -------------------------------------------------------------------------------------------- |
| <p>\<Dynamic Variable><br>(Required)</p> | This variable stores the percentage value representing how similar two images are.           |
| <p>\<Dynamic Variable><br>(Optional)</p> | <p>This variable stores the status as <strong>True</strong><br>or <strong>False</strong></p> |

**Example**

**Get the similarity percentage between two images**\
\
The **Get Image Similarity Percentage** action takes the value from the Input Value column (e.g., **C:\Images\Base.png;C:\Images\Output.png**) and calculates the visual similarity percentage between the two image files. The calculated percentage is stored in the **{Similarity Percent}** variable, and the action status is saved in the **{Status}** variable with the following possible values:

* **True** – if the similarity is calculated successfully
* **False** – if the simliarity is not calculated

<figure><img src="https://2174257472-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fk8QZzXZMIJSStKAzDSTu%2Fuploads%2FHWy2vosy5QDsRUQXzv6h%2Fimage.png?alt=media&amp;token=459a899c-986b-4468-950c-5fd76fd456a1" alt=""><figcaption></figcaption></figure>


---

# 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 by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.avoautomation.com/avo-assure/actions/generic/file-and-folder-operations/get-image-similarity-percentage.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

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.