The GoAI Search Consultant module integrates smart search functionality into your Magento 2 store, enhancing the user experience with customizable search capabilities.
This guide covers the installation process, script configuration, and verification steps.
You can install the module using two methods:
.zip file) from GoAI or the GoAI platform.Extract the .zip file to your computer.
Upload the extracted folder to the following directory in your Magento 2 installation:
Open a terminal and navigate to the root directory of your Magento 2 installation.
Run the following commands:
php bin/magento setup:upgrade
php bin/magento setup:di:compile
php bin/magento setup:static-content:deploy -f
Clear the cache with:
php bin/magento cache:flush
Follow these steps to install the GoAI module via Composer in your Magento 2 project.
Navigate to your Magento 2 root directory in your terminal:
cd /path/to/your/magento2
Add the GoAI repository to your composer.json file by including the following entry under "repositories":
{
"repositories": [
{
"type": "composer",
"url": "https://ai-repo.gomage.com"
}
]
}
Alternatively, you can use this Composer command to add the repository directly:
composer config repositories.goai composer https://ai-repo.gomage.com
2.2. Install the Module
Run the following Composer command to install the module:
composer require goai/search-consultant
After installing the module via Composer, run these commands:
php bin/magento setup:upgrade php bin/magento setup:di:compile php bin/magento setup:static-content:deploy -f php bin/magento cache:flush
When generating the script URL on the GoAI platform, you can customize the following parameters:
| Parameter | Description |
|---|---|
| clientUid | A unique identifier that links the script to your account. Example: 34dd0fnf748fmkf-sdfsd. |
| apiPoint | The API endpoint for processing search queries. Example: http://localhost:3000/api/data/ai_ecommerce_search/search/. |
| apiType | Specifies that Magento is used for integrating the search module. Example: magento. |
| buttonColor | Sets the button color in hexadecimal format. Example: #c83131 (red). |
| bgColor | Sets the background color in hexadecimal format. Example: #4a4343 (dark grey). |
| position | Specifies the button’s position on the screen. Options: bottom-right, bottom-left, top-right, top-left. Example: bottom-right. |
Your GoAI Search Consultant Module is now installed and ready to enhance your store’s search experience!