Knowledge
The knowledge base, under AI agent > Knowledge, is the content the assistant is allowed to answer from. Most of it arrives automatically from your Magento store; the rest you add here.
What arrives from Magento
The extension's sync pushes these content sources into the knowledge base, each into its category, which the extension creates on the first document:
| Source | --type | Category |
|---|---|---|
| Store information | store_info | Store Information |
| Products, with variants, attributes, and images | product | Products |
| Categories | category | Categories |
| CMS pages | cms_page | CMS Pages |
| Mirasvit Knowledge Base articles | kb_article | Knowledge Base |
| Mirasvit Blog MX posts | blog_mx | Blog |
| Mageplaza Blog posts | mageplaza_blog | Blog |
| Magefan Blog posts | magefan_blog | Blog |
The sync runs daily at 2:00 AM and can be triggered by hand - see How to sync data manually. After the first run, products are sent only when they change, and each one at least once every 30 days; the other sources are sent in full every time. Other extensions can add their own sources; see How to add a custom data source.
Browsing and filtering
Documents are listed per category, with a Filter by name or SKU box and a separate filter for the category tree. Long lists are paginated and the pager shows the total (Page 2 of 14 - 1,382 documents).
Adding a document by hand
Click New Document and fill in:
| Field | Description |
|---|---|
| Name | The document title. Required. |
| Body | The content. Markdown is supported. |
| Category | The category the document belongs to. |
| Identifier | A unique key for this document within the workspace. See the warning below. |
| Visibility | Currently only All. The field is reserved for future use. |
A document whose front matter names an image, as a synced product's does with its photo, shows that image on its edit page, under Category. A document without one has no image block.
Uploading files
Upload Documents takes files by drag and drop, or by clicking to select them, and imports them when you press Import.
Allowed formats: .txt, .md, .html, .csv, .json, .yaml, .xml, .pdf, .docx.
Categories
A category has a Name, an Identifier, a Description, a Parent category, and a Visibility. Categories nest, so you can group, for example, all policy documents under one parent.
Removing a category also removes every document inside it, and every child category with all of their documents. There is no undo.
Two rules worth knowing
A synced document is matched by its identifier (product.42, cms_page.7, and so on), and the sync overwrites whatever is stored under that identifier whenever it sends the document again. An edit to a synced CMS page, category or store information document is replaced on the next run, at 2:00 AM at the latest. An edit to a product document lasts until the product changes in Magento, and at most 30 days.
To add content that survives the sync, give it an identifier of your own that no provider uses, for example policy.warranty-eu. Editing the source in Magento is the reliable way to change a synced document.
For a short answer rather than a document, FAQ is the better home: no sync run touches an entry, and you do not have to invent an identifier to protect it.
With nothing synced, the assistant has no store-specific information to work with. The Widget settings have a Hide the chat until the knowledge base has content switch for exactly this window - see Settings.
Managing the knowledge base programmatically
Everything on this screen is also available over HTTP, which is the way to push content from a help desk, a blog, or a CI pipeline. See the REST API section.