Working With Modules
The Agents functionality is organized into discrete modules that can be enabled or disabled, which gives you full control over the user's experience.
Available Modules
Module | Identifier | Purpose |
---|---|---|
User Tracking | 'user-tracking' | This module captures the user behavior data, which powers Cartesian's agents and analytics. |
Recommendations | 'recommendations' | Provides product recommendations based on the user's behavior captured by the User Tracking module. |
Agent UI | 'agent-ui' | Controls the user interface elements for displaying recommendations and interacting with the agent. |
Controlling Modules
All modules are enabled by default, but you can disable and enable them in two ways:
Enabling and Disabling Modules using the SDK
You can enable and disable modules using the SDK using the this code:
- script
- npm
// Enable a module
window.Cartesian('module:enable', 'recommendations');
// Disable a module
window.Cartesian('module:disable', 'recommendations');
// Enable a module
Cartesian('module:enable', 'recommendations');
// Disable a module
Cartesian('module:disable', 'recommendations');
You can also enable and disable multiple modules in one go:
- script
- npm
// Enable multiple modules
window.Cartesian('module:enable', ['recommendations', 'agent-ui']);
// Disable multiple modules
window.Cartesian('module:disable', ['recommendations', 'agent-ui']);
// Enable multiple modules
Cartesian('module:enable', ['recommendations', 'agent-ui']);
// Disable multiple modules
Cartesian('module:disable', ['recommendations', 'agent-ui']);
Enabling and Disabling Modules using the Agent's Settings
You can also enable and disable modules from the Agent Settings screen, under the Modules
tab:
