Bei einer Help-Center-Verbundsuche sehen Endbenutzer im Help Center auch Ergebnisse aus externen Quellen. Wenn ein Endbenutzer also Ihr Help Center durchsucht, sind die Suchergebnisse nicht nur auf Ihre Help-Center-Beiträge oder Community-Posts beschränkt. Sie können die folgenden Quellen in die Verbundsuche aufnehmen: externe Wissensdatenbanken, Lernmanagement-Software, Blogs und Seiten Ihrer eigenen Website. Außerdem können Endbenutzer die Suchergebnisse nach Typ filtern (z. B. Blog-Posts).
Sie haben zwei Möglichkeiten, die Verbundsuche in Ihrem Help Center zu implementieren:
- Federated Search API – Mit dieser REST-API können Sie die externen Inhalte in die Zendesk-Suchindizes aufnehmen. Bei dieser Methode müssen Ihre Entwickler eine Middleware-Schicht für die Integration der Website mit den externen Inhalten in das Help Center aufbauen und pflegen.
- Such-Crawler – Der Such-Crawler kann in den Sucheinstellungen in Guide konfiguriert werden und ermöglicht Ihnen, die Verbundsuche ganz ohne Entwicklerressourcen in Ihrem Help Center zu implementieren. Sie können in den Sucheinstellungen Ihres Help Centers mehrere Crawler einrichten, um verschiedene Inhalte einer oder mehrerer Websites zu indizieren.
API und Crawler können auch gleichzeitig verwendet werden. Wenn Sie allerdings über die API eine Quelle oder einen Typ löschen, funktionieren Crawler, die Datensätze für die gelöschte Quelle oder den gelöschten Typ erstellen oder aktualisieren, nicht mehr.
In diesem Beitrag werden folgende Themen behandelt:
Funktionsweise des Such-Crawlers
Sie können einen oder mehrere Such-Crawler einrichten, um externe Inhalte zu indizieren, die Sie den Benutzern für die Suche in Ihrem Help Center bereitstellen möchten. Externe Websites, auf die Ihr Crawler zugreifen soll, müssen eine Sitemap aufweisen, in der die Seiten für den Such-Crawler aufgelistet sind. Seiten auf die Ihr Crawler zugreifen soll, müssen außerdem öffentlich sein (nicht authentifiziert). Wenn Sie authentifizierte Inhalte zur Help-Center-Suche hinzufügen möchten, müssen Sie die API für externe Inhalte verwenden.
Konfigurierte Crawler werden alle 12 bis 24 Stunden ausgeführt, besuchen die Seiten, die in der bei der Einrichtung angegebenen Sitemap aufgeführt sind, und übernehmen deren Inhalte in die Indizes für die Help-Center-Suche. Such-Crawler indizieren alle beim ersten Laden im Seitenquelltext enthaltenen Informationen, auch wenn diese durch ein UI-Element, etwa ein Akkordeon, verborgen sind. Da Crawler allerdings kein JavaScript ausführen, indizieren Sie keine Inhalte, die mittels JavaScript oder dynamisch nach dem ersten Laden der Seite dargestellt werden. Außerdem indizieren Crawler keine Links auf den von ihnen besuchten Seiten, sondern beschränken sich ausschließlich auf die Seiten in der Sitemap, für die sie eingerichtet wurden.
Sie können mehrere Crawler einrichten, um verschiedene Inhalte einer oder mehrerer Websites zu indizieren. Weitere Informationen finden Sie unter Einrichten des Such-Crawlers.
Wenn Benutzer eine Suche durchführen, werden externe Inhalte, die der Crawler gefunden hat, entsprechend ihrer Relevanz auf der Seite der Suchergebnisse angezeigt. Die Benutzer können die Ergebnisse filtern und auf die Links klicken, um die externen Inhalte in einer neuen Browser-Registerkarte anzuzeigen. Weitere Informationen zu Filtern finden Sie unter Help-Center-Anweisungen für Endbenutzer.
Funktionsweise der Federated Search API
Zendesk stellt eine REST-API bereit, mit der Ihre Entwickler angepasste Integrationen für die Einbindung externer Inhaltsdatensätze in die Suchindizes Ihres Help Centers erstellen können. Um externe Inhalte in die Suche aufzunehmen, müssen Ihre Entwickler die Anwendung, die Ihre externen Inhalte hostet, mit der External Content API integrieren.
Nach der Konfiguration liest die API externe Inhaltsdatensätze ein und fügt sie zu den Help-Center-Suchindizes hinzu. Indizierte Datensätze können dann der Suchmaschine des Help Centers für die Beantwortung von Suchanfragen zur Verfügung gestellt werden.
Weitere Informationen finden Sie unter Einrichten der Zendesk Federated Search API.
Externe Inhaltsquellen und Inhaltstypen
Unabhängig von der gewählten Einrichtungsmethode wird jeder von der Verbundsuche aufgenommene Inhaltsdatensatz mit einer Inhaltsquelle und einem Inhaltstyp verknüpft, mit denen Ihre Endbenutzer die Suchergebnisse filtern können. Weitere Informationen finden Sie unter Bearbeiten von Suchfiltern.
Inhaltsquellen und Inhaltstypen lassen sich entweder mit der Federated Search API oder beim Einrichten des Such-Crawlers in Guide definieren. Mit der API definierte Inhaltsquellen und Inhaltstypen können beim Einrichten des Such-Crawlers ausgewählt werden. Umgekehrt werden Inhaltsquellen und Inhaltstypen, die Sie beim Einrichten des Such-Crawlers erstellen, in die APIs external_content_type und die external_content_source aufgenommen. Weitere Informationen finden Sie in der Zendesk Federated Search API-Referenz (Englisch).
Sie können Suchergebnisse so konfigurieren, dass externe Inhaltsquellen ein- oder ausgeschlossen werden. Wenn externe Inhalte bei einer Help-Center-Suche berücksichtigt werden, gruppieren die Suchfilter die Inhalte nach Quelle und Typ, damit Benutzer die gesuchten Informationen leichter finden können. Durch „Quelle“ werden Inhalte nach Ursprung (z. B. Blog) und durch „Typ“ nach Art von Inhalt (z. B. Entwicklerdokumentation) gruppiert.
Achten Sie darauf, für Ihre externen Inhaltsquellen und Inhaltstypen sinnvolle Gruppen mit aussagekräftigen Namen einzurichten. So erleichtern Sie den Endbenutzern das Filtern der Suchergebnisse und damit das Auffinden der gesuchten Inhalte in Ihrem Help Center. Weitere Informationen finden Sie unter Bearbeiten von Suchfiltern.
Bekannte Einschränkungen der Verbundsuche
Im Moment sind die folgenden Einschränkungen für die Verbundsuche bekannt:
- Suchergebnisse aus externen Inhalten erscheinen in der Help-Center-Suche, im Abschnitt „Wissen“ im Kontextfenster und in Antworten der Unified Search API. In anderen von der Guide-Suchfunktion unterstützten Oberflächen wie der Sofortsuche oder der Article Search API werden sie nicht angezeigt.
- Der Such-Crawler funktioniert nicht mit Websites, die die Komprimierungscodierung gzip verwenden. Von diesen Websites werden keine Suchergebnisse angezeigt.
- Eine Crawl-Verzögerung (crawl-delay) wird vom Such-Crawler nicht beachtet, wenn sie in robots.txt-Einträgen für externe Websites festgelegt ist.