> For the complete documentation index, see [llms.txt](https://docs.altum.ai/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.altum.ai/english/property-valuation-and-market/interactive-reference-api/visual-similarity-search.md).

# Visual similarity search

<figure><img src="/files/seqIo2WnK9rEVVveQTP4" alt=""><figcaption><p>Visual similar properties</p></figcaption></figure>

## How to use

* Input "visual\_similarity": 1 to activate the function.
* Add a custom weight from 0.1 to 1 to determine the impact of sorting the results with 0.5 as default: "weight\_visualsimilarity": 0.5.
* Input an image for the target object via example “url”: “<https://house.image/facade-house.jpg”>.
* Optionally adjust the other weights to improve the sorting of visual similar properties. When only interested in the visual similarity of the reference objects, set the rest of the weights to zero: "weight\_innersurfacearea" : 0, "weight\_buildyear" : 0, "weight\_transactiondate" : 0, "weight\_distance" : 0.

{% hint style="info" %}

* Visual similarity can only be calculated for objects of which a facade image is known in the database.
* The performance of the API when activating “visual\_similarity” is slower because of the activation of the model to parse the images and find visual similar properties.
  {% endhint %}

## Results

* The reference objects are sorted based on the calculated weight
* Per reference object, additional information is returned:
  * Image: The facade image of the reference objects is added per reference object when known: “Image”: “<https://house.image/house.jpg”>.
  * Visual similarity score: “VisualSimilarityScore”: 82.425.


---

# 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.altum.ai/english/property-valuation-and-market/interactive-reference-api/visual-similarity-search.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.