> 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="/files/Ny157etDRUGOcsGEUN71" 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 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.avoautomation.com/avo-assure/actions/generic/file-and-folder-operations/get-image-similarity-percentage.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.
