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

# Get Image similarity Percentage

This is a pre-built Action located under the captured image element. The functionality of this action in Avo Assure is to compare the similarity percentage between the image captured from the application and the reference image provided in the input. The result is stored in the given dynamic variable for further use during test execution.

## **Syntax**

**Input Value**: `<image path>`

| Argument                           | Description                                                                                |
| ---------------------------------- | ------------------------------------------------------------------------------------------ |
| <p>\<image path><br>(Required)</p> | Provide the file path of the image you want to use for comparison with the captured image. |

**Output Value**: `<Dynamic Variable>;<Dynamic Variable>(Optional)`

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

### **Example: Calculating Similarity Percentage Between a Captured Element and a Reference Image**

In this example, we explain how to compare a captured application element with a reference image to calculate the similarity percentage.

* **Action**: Get Image similarity Percentage
* **Input Value**: C:\Images\reference.png
* The first argument (**C:\Images\reference.png**) specifies the file path of the reference image that will be used for comparison with the captured element.
* **Output Value**: {Percentage}
  * The similarity result (e.g., 80%) is stored in the **{Percentage}** dynamic variable.
  * If a second output variable is defined, it stores the action status with the following possible values:
    * **True**: If the image similarity percentage is retrieved.
    * **False**: If the image similarity percentage is not retrieved.
* **Logical Explanation**: The **Get Image similarity Percentage** action reads the reference image path from the **Input Value** column (**C:\Images\reference.png**). The action captures the current state of the target element and compares it with the provided reference image. It calculates the similarity percentage (80%) and stores the value in the **{Percentage}** variable.

<figure><img src="https://2174257472-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fk8QZzXZMIJSStKAzDSTu%2Fuploads%2FcpMxEsT86OkdxZe8v4p1%2Fimage.png?alt=media&amp;token=b7a1f575-5fb3-445d-add0-1ab843e186c9" 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/web/image/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.