App API - Image Search

Find the similar images to a provided search image

This App API call allows you to query your app for results which are the closest match to an image you provide to Graft through "entity_knn_adhoc" this needs to be an accessible uri to an image of interest.

If you are looking for a text example please see App API - Text Search

 

For entity_knn_adhoc, you need to stipulate the field that your search was configured against and the value you want to use as the search term.

For example if your Entity has an embedding (default name is my_config_embedding) using a single field called "image" the syntax is...

"entity_knn_adhoc": {"image":"https://graft.zendesk.com/hc/article_attachments/17962302051725"},

The App will automatically generate the code blob which can be copied using the button in the request window. You are able to modify the columns, output format and of course the image URI as needed within Graft, you may also modify the code to suit your own development environment as needed, including any valid column names. Modifying entity_knn_k determines the number of closest matches to return.

 

Sample Code 

curl https://app.graft.com/v1/query -H 'Content-Type: application/json' -X POST -d '{
"secret": " ... ENTER YOUR FULL API KEY HERE",
"output_format": "csv",
"organization": "docs",
"project": "<project_id>",
"app_name": "0",
"instance_name": "<instance_id>",
"entity": "my_entity_1",
"config_name": "my_config",
"entity_columns": [
"<column_1>",
"<column_2>",
"<column_3>",
"<column_4>",
"<column_5>"
],
"embedding_name": "my_config_embedding",
"entity_knn_adhoc": [
{
"image_uri": "https://graft.zendesk.com/hc/article_attachments/17962302051725"
}
],
"entity_knn_k": 10
}'