Help index
Re-indexes Knowledge Center pages so the in-app assistant can find them.
How it works
The in-app assistant answers questions by searching an index of the Knowledge Center, in which every page is split into sections and stored in a form that can be searched by meaning. This job rebuilds (or updates) that index:
- Splits pages into sections by heading
- Indexes the sections whose content has changed since the last run
- Saves them in the shared help index
- Removes leftovers — sections whose page no longer exists are removed when running in “full” mode
The job has two modes:
- Incremental — run automatically after the Knowledge Center is published. It is given the changed pages and their content
- Full reindex — reads every page from the Knowledge Center content folder (by default
/help/content). Used for a new installation or to recover a damaged index
The help index covers all of mTime, not one workspace. The job can only be run from the system workspace and is not listed in any other workspace.
When it runs
The job is operator-driven — there is no schedule. It runs automatically after each Knowledge Center publish; it can also be triggered manually.
Parameters
The trigger form shows no fields for this job; the options are passed through the API:
| Option | Description |
|---|---|
content_dir | Path to the Knowledge Center content folder. Used by the full reindex. Defaults to /help/content |
pages | A list of page paths with their content. Used by the incremental mode |
deleted_paths | A list of page paths to remove from the index |
full | Together with pages, removes every section whose page is not in the list. Use only when pages contains every page |
The job is skipped with skipped: true, reason: "embedder not configured" when the installation has no search indexing service set up.
Job results
| Metric | Description |
|---|---|
files_processed | Number of pages read |
chunks_created | New sections added |
chunks_updated | Existing sections that were indexed again |
chunks_deleted | Leftover sections removed |
chunks_skipped | Sections that had not changed (nothing to index) |
languages | Set of locales seen |
Troubleshooting
| Issue | Solution |
|---|---|
embedder not configured skip | The installation has no search indexing service. Either set one up, or accept that the assistant falls back to keyword search |
| Run fails with permission error | Verify the API key of the search indexing service is still valid |
| Assistant still returns outdated answers | Start a new assistant session. The index is read fresh on each question, but the assistant may remember earlier answers |