Webkul
Services
Technologies Bagisto QloApps
iOS Android SAP BigCommerce Wix
Trusted by
Samsung Intel Toyota Walmart Disney Nokia Nestlé Decathlon
See all customers
Back to Top
DOC

User Guide for ERPNext AI-Powered Product Image Search

Introduction

Website AI-Powered Product Image Search adds search by image to your ERPNext Webshop. A shopper uploads a photo, and the shop shows the products that look most like it.

The app turns each product photo into a list of numbers called image embeddings. It then compares the shopper’s photo with those numbers.

This visual product search works next to the normal text search.

This guide shows the store admin how to set up the app and store embeddings. It also shows how a shopper uses the camera button in the Webshop search bar.

Website Product Image Search works in conjunction with the following module:

Webshop

You must install the above-mentioned module to use the Website Product Image Search.

Features

  1. Add a camera button to the Webshop search bar.
  2. Let shoppers search by image from any device with a browser.
  3. Show a preview of the uploaded photo before the search runs.
  4. Zoom, crop, rotate, reset or replace the photo before searching.
  5. Store image embeddings for all published products, or only for chosen ones.
  6. Set the lowest match score and the most results to show.
  7. Show each match with its image, name, price and a link to the product.
  8. Mark embeddings as stale when a product changes, and delete them when you delete the product.
  9. Manage visual product search from the Website workspace.

Installation

  1. After purchasing the app from Webkul Store, you will receive a link to download the module ZIP file.
  2. Extract the ZIP file. You will see a folder named ‘website_product_image_search’.
  3. Set up the module in your git repository, then fetch it using:
bench get-app --branch main https://git.webkul.com/erpnext-apps/erpnext-ai-powered-image-search-product.git

(Replace “main” with your branch name and replace the “HTTPS URL” with your HTTPS clone URL.)

  1. Install the app on your site:
bench --site <your-site-name> install-app website_product_image_search
  1. Run bench migrate to complete the setup.

Workflow

Setting Up Image Search in the Backend

  1. Open the Website workspace. The app adds an Image Search section to the sidebar. It also adds two shortcuts under Product Image Search.
01-image-search-in-the-website-workspace
  1. Click Image Search Configuration, then click Add Image Search Configuration.
  2. Type a Configuration Name. Keep Enabled ticked.
  3. Under Search Behavior, leave Select Product set to All Products. Set Maximum Suggestions to the most results a shopper should see. Set Score Threshold to the lowest match score, from 0 to 1.
02-new-image-search-configuration-form
  1. Click Save. The Status shows Draft, because no image embeddings exist yet.
03-saved-configuration-in-draft-status
  1. Click Store Embeddings. The app reads the image of each published Website Item and saves its embedding. This can take a few minutes for a large catalog.
  2. Check the result. The Status changes to Stored, and Last Generated On shows the time. The Product Image Embedding box shows how many products are ready for search by image.
04-configuration-after-storing-embeddings

Note: The camera button appears in the Webshop search bar only after an enabled configuration reaches Stored status.

Searching Only Selected Products

  1. To limit visual product search to some items, set Select Product to Selected Products.
  2. Add one row per product in the Products table. Pick the Website Item in each row.
05-selected-products-table
  1. Click Save, then click Store Embeddings. The app will not save the form if the table is empty.

Reviewing Stored Embeddings

  1. Click Product Image Embedding in the sidebar. Each row is one product image, with its Status.
06-product-image-embedding-list
  1. Edit a Website Item, and the app marks its embedding Stale. The configuration also shows Stale. Search skips stale rows, so click Store Embeddings again after you change products.

Searching by Image on the Website

  1. Open the shop’s All Products page. A camera button now sits inside the Search for Products box in the Webshop search bar.
07-camera-button-in-the-product-search-box
  1. Click the camera button. The AI Image Search window opens. Click Click to upload image, or drag a photo onto it.
08-ai-image-search-upload-window
  1. Check the preview of the photo. Click Search to find matches, or click Edit to change the photo first.
09-uploaded-image-preview
  1. In the editor, use the toolbar to zoom out, zoom in, crop, rotate left, rotate right, reset or upload a new image. Drag the crop box to frame the product. Click the tick to save your changes and go back to the preview.
10-image-editor-with-crop-box
  1. Click Search. A spinner shows while the app looks for matches. The results open under the search box, with the best match first. Click a product to open its page.
11-similar-products-found-by-image-search

Need Help?

Hope you find this guide helpful! Please feel free to share your feedback in the comments below.

If you still have any issues/queries, please create a ticket at the UV Desk.

I hope this helps. In case of any further queries, contact us at our support mail.

Thanks for paying attention!!

Current Version – 1.0.0

Supported Framework Version – ERPNext v16

. . .

Leave a Comment

Your email address will not be published. Required fields are marked*


Be the first to comment.

Back to Top

Message Sent!

If you have more details or questions, you can reply to the received confirmation email.

Back to Home
IN THIS ARTICLE

Table of Content

Back to top