Zum Inhalt springen

Hilfeindex

Indiziert die Seiten des Knowledge Centers neu, damit der Assistent in der App sie finden kann.

So funktioniert es

Der Assistent in der App beantwortet Fragen, indem er einen Index des Knowledge Centers durchsucht, in dem jede Seite in Abschnitte aufgeteilt und in einer Form gespeichert ist, die sich nach Bedeutung durchsuchen lässt. Dieser Job baut diesen Index neu auf (oder aktualisiert ihn):

  1. Teilt Seiten anhand der Überschriften in Abschnitte auf
  2. Indiziert die Abschnitte, deren Inhalt sich seit dem letzten Lauf geändert hat
  3. Speichert sie im gemeinsamen Hilfeindex
  4. Entfernt Überreste — Abschnitte, deren Seite nicht mehr existiert, werden im Modus „vollständig“ entfernt

Der Job hat zwei Modi:

  • Inkrementell — läuft automatisch nach der Veröffentlichung des Knowledge Centers. Er erhält die geänderten Seiten und deren Inhalt
  • Vollständige Neuindizierung — liest jede Seite aus dem Inhaltsordner des Knowledge Centers (standardmäßig /help/content). Wird für eine Neuinstallation oder zur Wiederherstellung eines beschädigten Index verwendet

Der Hilfeindex gilt für ganz mTime, nicht für einen einzelnen Arbeitsbereich. Der Job kann nur aus dem Systemarbeitsbereich ausgeführt werden und wird in keinem anderen Arbeitsbereich aufgeführt.

Wann er läuft

Der Job wird manuell gesteuert — es gibt keinen Zeitplan. Er läuft automatisch nach jeder Veröffentlichung des Knowledge Centers; er kann auch manuell gestartet werden.

Parameter

Das Startformular zeigt für diesen Job keine Felder; die Optionen werden über die API übergeben:

OptionBeschreibung
content_dirPfad zum Inhaltsordner des Knowledge Centers. Wird von der vollständigen Neuindizierung verwendet. Standard ist /help/content
pagesEine Liste von Seitenpfaden mit ihrem Inhalt. Wird vom inkrementellen Modus verwendet
deleted_pathsEine Liste von Seitenpfaden, die aus dem Index entfernt werden
fullEntfernt zusammen mit pages jeden Abschnitt, dessen Seite nicht in der Liste steht. Nur verwenden, wenn pages jede Seite enthält

Der Job wird mit skipped: true, reason: "embedder not configured" übersprungen, wenn für die Installation kein Suchindizierungsdienst eingerichtet ist.

Jobergebnisse

KennzahlBeschreibung
files_processedAnzahl der gelesenen Seiten
chunks_createdNeu hinzugefügte Abschnitte
chunks_updatedBestehende Abschnitte, die erneut indiziert wurden
chunks_deletedEntfernte Überreste
chunks_skippedAbschnitte, die sich nicht geändert hatten (nichts zu indizieren)
languagesMenge der vorgefundenen Sprachen

Fehlerbehebung

ProblemLösung
Übersprungen mit embedder not configuredDie Installation hat keinen Suchindizierungsdienst. Richten Sie einen ein, oder nehmen Sie in Kauf, dass der Assistent auf Stichwortsuche zurückgreift
Lauf schlägt mit Berechtigungsfehler fehlPrüfen Sie, ob der API-Schlüssel des Suchindizierungsdienstes noch gültig ist
Der Assistent liefert weiterhin veraltete AntwortenStarten Sie eine neue Sitzung mit dem Assistenten. Der Index wird bei jeder Frage neu gelesen, aber der Assistent erinnert sich möglicherweise an frühere Antworten