Guide for WooCommerce AI Image & Semantic Search

The following minimum system requirements are needed for this extension,

• Python Version – 3.10
• CPU cores – 4
• RAM – 6GB at least (for local model) or 4GB (for hosted models), or may increase the requirement for a large no of data.
• space – 30GB
• Server key and cert files (for Flask API)
• Docker (Optional)
• Three ports (5000,5001, and 8000)
• API Key (If you would like to use Hosted Platforms like Gemini, OpenAI, etc. for creating text embeddings or  Semantic Search API) – Optional

To install AI module, we need SSH access. You can also check the AI Models Server Installation Guide and ChromaDB Installation Guide for reference.

The user will get a zip file that they have to upload in the “Add New Plugin” menu option in the WordPress admin panel.

For this, login to the WordPress Admin Panel, and under the dashboard, click on the “Plugins” menu option. This brings out a Sub-Menu, and then select the “Add New Plugin” option.

After that, you will see an option on the top of your page which is “Upload Plugin“, click on it to upload the zip file,

After clicking on it, you will see the button “Choose File“, use it to upload the zip file,

Once the zip file is uploaded, click on “Install Now” button to install the plugin as per the snapshot,

Now, when the plugin is installed correctly, you will see the success message. Additionally, an option to activate the plugin.

Click on “Activate Plugin” to activate the installed plugin.

Know how to translate the module.

Check how to activate the WooCommerce Plugin through the purchase code and get updates on Webkul Modules directly on the Plugins page

NOTE: To generate JSON from your translations, save your translation file in the default WordPress languages directly, then run the following command in the same directory:

Note xx_YY refers to the locale (eg. en_US)

wp i18n make-json wc_pos-xx_YY.po –no-purge

The admin has to flush the permalink by navigating to Settings>Permalinks so that links to the AI Image & Semantic Search work correctly.

Please follow the below given steps to configure ChromaDB.

1. Install the following packages on your server.
   a) Docker
   b) docker-compose
2. Download the chromaDB zip (https://raw.githubusercontent.com/wpwebkul/chroma/master/chromaDb.zip ) and extract on your server in any location.
3. Run the following command inside the chromaDB folder (extracted folder).

docker-compose up -d --build

After successfully installing the WooCommerce AI Image & Semantic Search plugin, they have to navigate to Webkul WC Addons>AI Semantic Search.

The admin needs to configure the following,

Settings

General Configs

Under this section, the admin has to set the following fields,

• Image Search: Enable or Disable to search via Image.

• Override WooCommerce Search: Enable this to override the default WooCommerce search with Semantic search.

• Default Listing Limit: Set the default items listing limit.

• Search Result Limit: Field to manage the maximum search items.

Theme Appearance

Under this section, the admin can personalize the theme. The changes made here will be visible on the storefront.

They can modify the appearance and make it suitable as per their requirement.

Under this section, the following configurations are available,

• Product Style: Set the style of the product.

• Product Color: Set the product color either as “Fetched from Image” or “Primary Color“

• Primary Color: Select a primary color.

• Background Color: Set a background color.

• Text Color: Select a text color.

• Product Text Color: Select the color of the product text.

• Border Color: Set border color.

• Border Radius: Adjust the border radius.

Shortcode Information for Semantic Search

The shortcode is provided with the plugin to set up the AI Image and Semantic search. Options and range values are also provided.

Admin can utilize it to set the image and phrase searching as per the requirement.

Setup Semantic Search with Shortcode

With the help of the Shortcode provided with the plugin, one can set up the Semantic Search to be visible on the frontend.

Please follow the steps below to set it up.

• From the WordPress Admin Panel dashboard, navigate to Pages>Add New Page.

• Now, click on Add New Page to add a new page on the storefront.
• Edit the page as per requirement, add the Shortcode provided, and publish the page.

• Once the page is published, it will be visible on the frontend with the image and semantic search enabled.

Sync Products

AI product search through images and text will work on only those products which have been synced with the plugin.

The admin can sync, unsync and resync the products listed on the store as per the requirement.

Products can be synced and unsynced in Bulk. A search bar is also provided to search for the products.

API Setup

To use the Text Embedding Server and Image Server, follow the steps provided in this guide: AI Models Server Installation Guide

API configuration

• Text Embedding Server: Enter the Text Embedding Server address.
• Image Server: Enter the image Server address.
• Chroma DB Server: Enter the Chroma DB Server address.
• Token: Enter the token key for authentication.

Once the AI Image and Semantic search for products has been set up, the customers can use it on the frontend.

They can either enter a phrase in the text bar or upload an image through the upload image button provided beside the search button.

They will get the option of searching through phrases and images as per the snapshot below,

An example of a phrase search is provided below with the prompt,”Show me Blue Shirt,” which will display all the relevant products.

The AI Image & Semantic search plugin for WooCommerce is also responsive and works well in the Mobile View.

So, that’s all for the WooCommerce AI Image & Semantic Search plugin.

If you have any more queries or suggestions, kindly reach out to us through support@webkul.com or create a ticket through webkul.uvdesk.com