UpStart Commerce Search
Image Search
Enable Image Search with PIM
4min
to enable image search in your index, you must create a product templates with a special attribute this product template does not need to be used in your products it is just to enable the image search feature create an attribute with the next knn search properties and name curl location 'https //api upstartcommerce com/pim/attributes' \\ \ header 'x upstart tenant tenant id' \\ \ header 'x upstart site\ site id' \\ \ header 'content type application/json' \\ \ header 'x upstart api key api key' \\ \ data '{ "name" "media url", "typename" "string", "admindisplayconfiguration" { "admindisplayname" { "localizations" { "en us" "attribute for image search" } }, "displaygroup" "string", "inputtype" "text", "helpertext" { "localizations" { "en us" "attribute for image search" } } }, "displayname" { "localizations" { "en us" "attribute for image search" } }, "description" { "localizations" { "en us" "attribute for image search" } }, "searchproperties" { "knnvectorsupported" true, "indexed" false, "knnvectorembeddings" { "image model" { "dimension" 768, "method" { "name" "hnsw", "space type" "l2", "engine" "faiss" } } } }, "multivalued" false, "priority" 0, "scope" "product", "isrequired" false, "draft" true }' commit the attribute curl location 'https //api upstartcommerce com/pim/batch/attributes/change status' \\ \ header 'x upstart tenant tenant id' \\ \ header 'x upstart site site id' \\ \ header 'content type application/json' \\ \ header 'x upstart api key api key' \\ \ data '\[ { "id" "attribute id", "status" "commit" } ]' create the product template with the attribute and publish the detailed steps to create a product template can be viewed on product templates go to your upstart commerce portal access pim and then go to product templates docid 3ivoqv3bkrkg xw876ash click on create template add a name and description to the product template (for example to enable image search) select the product type click on create & open , search for the image search attribute and add it to the product template click on publish reach out to upstart commerce team to reindex your catalog indexes to fully enable image search