The Ecommerce Search Consultant is an AI-powered module for e-commerce systems designed to help users find products based on their search queries. The module connects to platforms like Magento 2 or Shopify, fetches product data, and delivers relevant search results to users.
Open the GoAI Dashboard
- Log in to the GoAI Dashboard to manage your assistant configurations.
Find the “Ecommerce Search Consultation” Section in the Menu
- In the Sidebar Menu, navigate to “Ecommerce Search Consultation.”
- Select the “Configurations” option.
Configure the Required Settings
Make the necessary changes in the following sections:
- General Configuration – Configure button color, background color, and button position.
- API Tokens – Enter API tokens to connect AI models.
- Magento 2 – Set up the connection to your Magento 2 platform.
Save the Configuration
- Click the “Save Configuration” button to save your changes.
Verify the Module Operation
- Ensure the search button appears in the selected position.
- Perform a test search on your site to check if the results are accurate.
The Analytics System provides detailed insights into search queries, token usage, and user interactions with the AI-powered search assistant. This helps you optimize the module’s performance and improve search quality.
- Total Tokens: The total number of tokens used.
- Tokens with Results: Tokens that led to successful search results.
- Tokens without Results: Tokens that did not return any results.
- Purpose: This chart shows how frequently user queries return successful results.
- Purpose: Displays the number of tokens used each week.
- Device Types:
- Desktop
- Mobile
- Tablet
- Unknown
- Purpose: Helps identify which devices are most commonly used for searches.
- Purpose: Displays countries where users most frequently interact with the search assistant.
- Details Included:
- Product URL
- Product Options
- Search Query
- Country
- Tokens Used
- Purpose: Provides a detailed view of the latest search queries and the products recommended by the AI assistant.
- Open the GoAI Dashboard.
- Navigate to “Ecommerce Search Consultation” → “Dashboard.”
- Review the charts and tables to get detailed insights into the module's usage.
- Analyze the data to optimize search queries and improve the module’s effectiveness.
This section allows you to customize the appearance of the search assistant, including button colors, background colors, and button positioning on the page.
- Type: Color picker (
color).
- Key:
buttonColor
- Default:
#000000 (black).
- Purpose: Sets the color of the search button.
- Type: Color picker (
color).
- Key:
bgColor
- Default:
#ffffff (white).
- Purpose: Sets the background color for the search panel.
- Type: Dropdown menu (
select).
- Key:
AIModelPosition
- Options:
- Bottom Right – Displays the button in the bottom right corner.
- Bottom Left – Displays the button in the bottom left corner.
- Purpose: Determines where the search button is positioned on the page.
¶ Allowed Domains
- Type: Dynamic fields (
dynamic_fields).
- Key:
allowedDomains
- Tooltip: Enter allowed domains separated by commas for AI integration.
- Purpose: Restricts the AI assistant to operate only on specified domains.
This section allows you to configure the tokens for integrating different AI models.
- Type: Dropdown menu (
select).
- Key:
AIModelName
- Options:
- OpenAI GPT-4o
- OpenAI GPT-4o-mini
- LLaMA3.2 8b (Demo)
- Purpose: Select the AI model to handle search queries.
- Type: Password field (
password).
- Key:
modelToken
- Purpose: Enter the API token for accessing the selected AI model.
- Type: Text field (
text).
- Key:
modelAPIUrl
- Purpose: Enter the API URL for the selected AI model (if applicable).
This section allows you to connect the Ecommerce Search Consultant to the Magento 2 platform and configure settings for interacting with products, categories, and attributes.
- Type: Text field (
text).
- Key:
magentoProductsDomainURL
- Tooltip: Enter the Magento 2 API URL in the format:
{MAGENTO_BASE_URL}/rest/V1/products.
- Purpose: URL to fetch product data from Magento 2.
- Type: Dropdown menu (
select).
- Key:
magentoCategorySegmentation
- Options:
- Yes – Enable category segmentation.
- No – Disable category segmentation.
- Purpose: Enable or disable category segmentation for the search.
- Type: Dropdown menu (
select).
- Key:
magentoProductVisibility
- Options:
- Disable – Disabled.
- Not Visible Individually – Not visible individually.
- Catalog – Visible in the catalog.
- Search – Visible in search results.
- Catalog, Search – Visible in both catalog and search results.
- Purpose: Sets the visibility of products for the AI search assistant.
- Type: Text field (
text).
- Key:
magentoCategoryDomainURL
- Tooltip: Enter the Magento 2 API URL in the format:
{MAGENTO_BASE_URL}/rest/V1/categories.
- Purpose: URL to fetch category data from Magento 2.
- Type: Text field (
text).
- Key:
magentoProductURLExtension
- Tooltip: Enter the product URL extension, e.g.,
.html.
- Purpose: Adds a URL extension to product links.
- Type: Dynamic fields (
dynamic_fields).
- Key:
magentoAdditionalAttributes
- Tooltip: Enter additional attribute codes separated by commas.
- Purpose: Adds extra product attributes for AI search integration.
- Type: Text field (
text).
- Key:
magentoAttributesDomainURL
- Tooltip: Enter the Magento 2 API URL in the format:
{MAGENTO_BASE_URL}/rest/V1/products/attributes.
- Purpose: URL to fetch product attributes from Magento 2.
- Type: Dynamic fields (
dynamic_fields).
- Key:
magentoAdditionalAttributesOfConfigurableProducts
- Tooltip: Enter additional attribute codes separated by commas.
- Purpose: Adds extra attributes for configurable products.
- Type: Password field (
password).
- Key:
magentoAccessToken
- Purpose: Enter the access token for Magento API.
- Type: Text field (
text).
- Key:
magentoChunks
- Purpose: Sets the maximum number of token chunks per request.
- Type: Text area (
textarea_js_code).
- Key:
magentoJavaScriptConnectCode
- Purpose: Generates the JavaScript code to connect the module to Magento 2.
- Note: This field is read-only and automatically generates the script.
These settings help you integrate and configure the AI assistant to optimize product search on your e-commerce platform.