> 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/web/custom/get-image-similarity-percentage.md).

# Get Image similarity Percentage

This is a pre-built Action located under the **Custom** **element.** The functionality of this action in Avo Assure to compare and return the similarity percentage between the image specified in the input and the image provided through the image path, and store the result in given dynamic variable.

### **Syntax**

**Input Value:**`<ObjectType>;<VisibleText(optional)>;<Index>;<ImagePath>;<abs(optional)>`

| Argument                            | Description                                                                                                    |
| ----------------------------------- | -------------------------------------------------------------------------------------------------------------- |
| <p>\<ObjectType><br>(Required)</p>  | Specify the type of object (e.g., Image)                                                                       |
| <p>\<VisibleText><br>(Optional)</p> | Enter the visible text on the object                                                                           |
| <p>\<Index><br>(Required)</p>       | Provide the index of the object inside the page                                                                |
| <p>\<ImagePath><br>(Required)</p>   | Path of the image to be compared                                                                               |
| <p>\<abs></p><p>(Optional)</p>      | If the **abs** is provided, the action is performed with absolute identification using the **absolute X path** |

{% hint style="warning" %}
**Note:** If abs is included, the action will be executed by matching the object with absolute performance using the visible text.&#x20;

*To skip an optional input value, use an extra semicolon (;).*
{% endhint %}

#### **Output Value**

| Argument                                 | Description                                                                          |
| ---------------------------------------- | ------------------------------------------------------------------------------------ |
| <p>\<Dynamic Variable><br>(Required)</p> | This variable holds the image similarity percentage                                  |
| <p>\<Dynamic Variable><br>(Optional)</p> | This dynamic variable stores the result of the verification as **True** or **False** |

**Example**

**Find the similarity percentage between a specified object's image and a reference image.**

The **Get Image Similarity Percentage** action takes the value from the Input Value column (e.g., **img;;0;C:\TestImages\ExpectedLogo.png**) and compares the actual image on the application with the given image path. The similarity percentage is stored in the **{Percentage}** variable, while the execution status is stored in the **{Status}** variable, with the following possible values:

* **True** – if the similarity calculation is successful.
* **False** – if the similarity check fails.

<figure><img src="/files/Nhxq44Hh2bEoRMTjEkiP" 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/web/custom/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.