Tag: Search Products by Image

OpenCart Image Search Extension – User Manual

1.0 Introduction

Knowband offers OpenCart Image Search Extension which implements image search functionality on the website. The online users just need to upload an image from the website front-end interface and as a result, they can view the matched products. Admin can set a higher threshold value from the admin interface for offering accurate results. The online merchant can show an image search option near the search box and on product pages as the “Search Visually same product” button.

The eCommerce store merchant can check total images, mapped images, unmapped images and total images yet to be synced. There is a specific link for viewing the reasons behind the unmapping of the images. This way, the online store merchant can implement an email search on the website and offer a better store experience to the customers.

1.1 Features of OpenCart Image Search Extension

  1. Online merchants can implement image search functionality on the website using the OpenCart Image Search Extension.
  2. This OpenCart Image Search Extension recognizes the uploaded image and provides matching products in the search result.
  3. The online users just need to upload images for searching the desired products.
  4. There is an option to display the image search option near the search bar. Admin just needs to enable this option from the admin interface of this Search by Image module for OpenCart.
  5. The eCommerce store merchant can also enable us to show the “Search visually same Products” button on the website’s product pages.
  6. The Search by Image module for OpenCart has the functionality to sync the newly added product images automatically.
  7. There is an option to set threshold percentage according to which, admin can show more accurate results of image search. The range can vary from 50 to 100 where 95 is the recommended value for accuracy of results.
  8. OpenCart Image Search plugin provides steps for generating an API key from the clarified portal.
  9. The OpenCart store admin can view total available images and mapped images details in the OpenCart Image Recognition System admin interface.
  10. The online store admin can also view the number of unmapped images along with un-mapping reasons.
  11. The online sellers can also view the number of images that needs to be synced.
  12. With this Search by Image plugin for OpenCart, admin can offer a better user experience to the customers.
  13. OpenCart Image Recognition System has a Machine Learning feature that recognizes the uploaded images and shows matching product images in the image search result.

2.0 Installation

Buy OpenCart Image Search Extension from the store. You will receive these files:

  • First, you will get a source code file of the OpenCart Image Search Extension in a zipped file format.
  • User Manual of this OpenCart Image Search module.

Follow below-mentioned steps to install OpenCart Image Search Extension:

1. Unzip the received zip file. You will get the folders.

2. Copy all the folders of the zip file in the Root Directory of OpenCart setup via FTP manager.

3. There will be a file named kbimage_search.ocmod.xml (In case of Openvar v3.0.x file name would be kbimage_search.ocmod.zip). Upload the same file from the page “Admin -> Extension -> Extension Installer -> upload”.

So, OpenCart Image Search Extension is now successfully installed and ready to use at your store.

Now go to the admin menu and click on the extensions and thereby click on the configure button next to the OpenCart Image Search module.

3.0 Admin Interface

After the successful installation of OpenCart Image Search Extension, the online store merchant can easily implement the conditions and show the image search option on the website front-end interface.

There are two configuration sections:

  • General Settings
  • Unmapped images    

3.1 General Settings

In the General settings section, the online store merchant can apply the basic settings for image search. The OpenCart Image Search module is highly customizable and offers smooth functioning to the users.

knowband-opencart-search-by-image-general-setting

These are the configuration options:

  • Status of the module: Activate or deactivate this OpenCart Image Search Extension functionality by enabling or disabling this option.
  • Enable Image Search Option On search bar: The online merchant can show or hide the image search button from the search bar.
  • Enable Visual same search button: Admin can show or hide a button on the product page to search visually the same images. Customers just need to click on this button to view similar product images.
  • Enable Automatic image Sync: The online store merchant can activate this configuration option for automatically syncing the newly added product images.
  • Threshold percentage: Admin needs to add a range between 50 to 100 as a threshold percentage.
  • Product Per Page: The store admin can add the number of products he wants to show for the image search results.
  • API key: Admin can check the steps to generate an API key in the provided link and set it from the admin interface.

Apart from these settings, the admin needs to configure CRON setup and admin can run cron manually for image mapping. Steps for API key generation are given and admin can easily follow the steps to generate an API key.


Admin can also check the number of total images, mapped images and number of images that needs to be synced. Apart from that, admin can also check the data of unmapped images and he can click on the link for getting the reason behind unmapping.

3.2 Unmapped Image Log

Admin can click on the provided URL for checking the details of the unmapped image. Here admin can view the product id and reason behind the unmapping of the image.

4.0 Front-end Interface

The online users can view the image search options on the website’s front-end interface and use it for their convenience.

The online users can view the image search option on the search bar as shown below:


Online users just need to upload an image and click on the search button for the proceeding image search option. Check the below-mentioned image:

In search results, online users can view the products which meet the search criteria and they can easily find the desired products without any hassle or time taking process.

The search result will show an error in case of the unavailability of matching images.

The OpenCart Image Search plugin also provides an option to show “visually similar product”. The online users can click on this button and check the visually same products.


This way, the online users can easily get the desired products without wasting much time and efforts. The eCommerce store merchant can easily configure the Search by Image module for OpenCart and implement image search functionality.

Prestashop Image Search Addon – User Manual

1.0 Introduction

Improve the search experience of your customers on your store. Incorporate Knowband’s Prestashop Image Search Addon and help your customers to search for a product using product image. This saves the time of your customers and improves their shopping experience as well. Through machine learning, the Image Search addon recognizes the image uploaded by a customer and displays relevant results.

1.1 Striking Features of Prestashop Image Search Addon

Prestashop Image Search Addon is highly customizable plugin with no technical changes involved. You can upload or add as many images for your eCommerce store and map them corresponding to products. Lets quickly check different features offered by this Prestashop Image Recognition System.

1. Prestashop Image Search module allows your customers to search products at your store using an image.

2. You can provide “Search Products by Image” option on search bar of website.

3. With Prestashop Image Search module, you can enable or disable Visual Same Search Button on the product pages.

4. You can enable or disable the automatic image sync feature to map images corresponding to products.

5. You can run the cron file to manually map the images to products. Once mapped, they will appear in image search results.

6. Prestashop Image Search Addon supports multi-lingual and multi-store compatibility.

7. You have an option to set threshold percentage ranging between 50 to 100. Based on this value, the matched search results are shown.

8. You can set the number of products which will be displayed on the search result page.

9. Prestashop Image Recognition System is simple to enable or disable from back-office interface.

10. The total details like Total Images, Total Mapped Images, Total Unmapped Images, Total Images yet to be Synced are shown at back-office of module.

1.2 Technology for Development

Language: PHP
Frame Work: Prestashop

2.0 Installation Guide for Prestashop Image Search Addon

You can follow these simple steps for installing the Prestashop Image Search module on your eCommerce store:

1. Firstly, download the addon package from the Knowband store.

2. You will get a zipped file containing the source code and user manual. Unzip the complete package in the root directory of your Prestashop store through FTP manager (like Filezilla or WinSCP – download here: https://filezilla-project.org/). You’ll find the files and folders as shown in the image below:

3. The Prestashop Image Search module is all set to be installed at your store. Go to the Store Admin and then to ‘Modules and Services’.

4. Click on the “Install” button just next to your module. It would show a pop-up for your confirmation. Click on “Proceed with the installation” option. This step will install the module and show notification – “Module(s) installed successfully”.

3.0 Admin Interface of Prestashop Image Recognition System

Once you have successfully installed Prestashop Image Search Addon on your store, you can configure the Image Search settings from the admin backend. The module settings are categorized under two tabs as shown below:

Here in this interface of Prestashop Image Search Addon, you will find two tabs as listed below.

1.General Settings
2.Unmapped Image Log

Each section of this Prestashop Image Search module has been discussed below.

3.1 General Settings

  • Enable/Disable: Using this option, you can enable or disable the functionality of Prestashop Image Search module for your store.
  • Enable Image Search Option on Search Bar: This option shows or hide the Image Search option on the Search Bar.
  • Enable Visual Same Search Button: This option enables or disables the “Search Visually Same Products” button on the product page.
  • Enable Automatic Image Sync: If this option is enabled, then it will automatically map all the newly added unmapped images. If this is disabled, you have to hit and run cron file manually in order to map the unmapped images.
  • Threshold Percentage: Using this option, you can set a threshold percentage match value ranging between 50 to 100. Based on this value, module shows the image search results on the frontend. For best results, set the threshold value as 95.
  • Product Per Page: With this option, you can set the number of products or search results which will be shown per page.
  • API Key: This option will set the API key for Clarifai account. The steps to generate API key are provided at the back-office.

A) Total Images: This count is incremented as you will add new images to any product.
B) Total Mapped Images: This count indicates total mapped images either automatically or manually by running cron.
C) Total UnMapped Images: This count indicates total unmapped images due to some error like API not found or wrong API key.
D) Total Images Yet To Be Synced: The value indicates the images which were not mapped automatically or using cron file. Once you hit the cron file or enable the “Enable Automatic Image Sync” option, the count becomes zero.

3.2 Unmapped Image Log

Under this tab of Prestashop Image Search module, you will find details of unmapped images. All the images that are unmapped because of wrong API key are listed along with details like Product ID, Product Name, Error Description, Error Status Code and Upload Date.

4.0 Front Interface of Prestashop Image Recognition System

A) Image Search Option at Front

B) Choose file for “Search by Image” option

C) When relevant search results are found for the uploaded image.

D) When no results are found for the uploaded image.

E) Image Search option on product page