To configure and start using Intelligent Search, you must have some search applications installed:
admin-search
: This application allows you to configure all the features available in the Admin by Intelligent Search.search-resolver
: The main backend application for Intelligent Search, which processes all search queries.
Some stores have these applications installed by default, while others require you to follow the installation steps. See below how to check if they are installed and, if necessary, proceed with the installation.
Checking the Edition App
Edition App is a predefined set of essential applications that support the development of a store. Depending on your store's Edition App, you may have the Intelligent Search applications by default or need to install them, as detailed in the table below:
Edition App | Description |
---|---|
vtex.edition-store@5.x | Intelligent Search is already included, so you don't need to install the applications in this guide. Proceed to Start integration with the Catalog. |
vtex.edition-store@4.x | You need to install search applications manually. Follow the instructions for Installing search applications. |
vtex.edition-store@3.x | You need to install search applications manually. Follow the instructions for Installing search applications. |
Previous versions of vtex.edition-store | Not compatible with Intelligent Search. If you want to migrate to a compatible version, please contact Support. |
vtex.edition-business@0.x | Not compatible with Intelligent Search. If you want to migrate to a compatible version, please contact Support. |
To determine which Edition App your store is currently using, consult your development team. They can identify the Edition App by using the vtex edition get
command in VTEX IO CLI, as described in the command reference available in the Developer Portal.
Installing search applications
If your store uses vtex.edition-store@3.x
or vtex.edition-store@4.x
, ask your development team to install admin-search
and search-resolver
.
To install the applications, use the vtex install vtex.admin-search vtex.search-resolver
command in VTEX IO CLI as described in the Intelligent Search implementation guide.