La recherche fédérée du centre d’aide permet à vos utilisateurs finaux de voir du contenu externe dans les résultats de recherche dans le centre d’aide. Ainsi, quand un utilisateur final fait une recherche dans votre centre d’aide, les résultats ne se limitent pas aux articles de votre centre d’aide et aux publications de votre communauté. La recherche fédérée peut notamment inclure des bases de connaissances externes, des logiciels de gestion de l’apprentissage, des blogs et des pages de votre site Web. Vos utilisateurs finaux peuvent aussi filtrer leur recherche par type (par publications de blog, p. ex.).
Vous pouvez utiliser l’une des deux méthodes suivantes pour implémenter la recherche fédérée dans votre centre d’aide :
- API Recherche fédérée - Une API REST qui vous permet d’ingérer des enregistrements de votre contenu externe dans les index de recherche Zendesk. Pour que vous puissiez utiliser cette méthode, vos développeurs doivent créer et maintenir une couche interlogicielle pour intégrer le site qui héberge le contenu externe et le centre d’aide.
- Crawler de recherche - Configurable dans les paramètres de recherche de Guide, le crawler de recherche vous permet d’implémenter la recherche fédérée dans votre centre d’aide sans avoir recours aux ressources pour les développeurs. Vous pouvez configurer plusieurs crawlers dans les paramètres de recherche de votre centre d’aide pour explorer et indexer différents contenus dans un ou plusieurs sites Web.
Vous pouvez utiliser l’API et le crawler en même temps. Cependant, si vous supprimez une source ou un type via l’API, tous les crawlers qui créent ou mettent à jour des enregistrements pour la source ou le type sélectionné arrêteront de fonctionner.
Cet article aborde les sujets suivants :
Fonctionnement du crawler de recherche
Vous pouvez configurer un ou plusieurs crawlers de recherche pour explorer et indexer le contenu externe que vous voulez mettre à la disposition des utilisateurs qui effectuent des recherches dans votre centre d’aide. Les sites externes que vous voulez explorer doivent avoir un plan du site qui répertorie les pages pour le crawler de recherche. En outre, les pages que vous voulez explorer doivent être publiques (non authentifiées). Si vous voulez ajouter du contenu authentifié à la recherche dans le centre d’aide, vous devez utiliser l’API de contenu externe.
Une fois configurés, les crawlers s’exécutent toutes les 12 à 24 heures : ils visitent les pages du plan du site que vous avez spécifiées pendant la configuration et ingèrent le contenu de ces sources dans les index de recherche du centre d’aide. Les crawlers de recherche indexent le contenu qui se trouve dans la page source au chargement initial de la page, même s’il est masqué par un élément de l’interface, comme un accordéon. Cependant, puisque les crawlers n’exécutent pas JavaScript, ils n’explorent pas le contenu rendu par JavaScript ou tout autre contenu rendu dynamiquement après le chargement initial de la page. En outre, les crawlers n’explorent pas les liens qui se trouvent sur les pages qu’ils visitent, ils visitent uniquement les pages du plan du site qu’ils sont configurés pour utiliser.
Vous pouvez configurer plusieurs crawlers pour explorer et indexer différents contenus dans un ou plusieurs sites Web. Consultez Configuration du crawler de recherche.
Quand un utilisateur effectue une recherche, le content externe pertinent découvert par le crawler est classé et présenté à la page des résultats de recherche. Là, l’utilisateur peut filtrer les résultats et cliquer sur les liens pour consulter le lien du contenu externe dans un autre onglet de navigateur. Pour en savoir plus au sujet des filtres, consultez le guide du centre d’aide pour les utilisateurs finaux.
Fonctionnement de l’API Recherche fédérée
Zendesk fournit une API REST qui permet à vos développeurs de créer des intégrations personnalisées pour ingérer les enregistrements de contenu dans les index de recherche de votre centre d’aide. Pour ingérer du contenu externe pour la recherche, vos développeurs doivent intégrer l’application qui héberge votre contenu externe avec l’API de contenu externe.
Une fois configurée, l’API ingère les enregistrements de contenu externe et les ajoute aux index de recherche du centre d’aide. Les enregistrements indexés peuvent alors être mis à la disposition du moteur de recherche du centre d’aide quand il répond aux recherches des utilisateurs.
Pour en savoir plus, consultez Configuration de l’API de la recherche fédérée Zendesk.
Sources et types de contenu externe
Quelle que soit la méthode de configuration que vous utilisez, chaque enregistrement de contenu ingéré par la recherche fédérée est associé à une source et un type de contenu, qui servent à filtrer les résultats de recherche de votre utilisateur final. Consultez Modification des filtres de recherche.
Vous pouvez définir des sources et des types en utilisant l’API Recherche fédérée ou au moment de la configuration du crawler de recherche dans Guide. Si vous définissez des sources et des types en utilisant l’API, vous pourrez les sélectionner quand vous configurez le crawler de recherche. De la même façon, si vous créez une source et un type de contenu quand vous configurez le crawler de recherche, ils seront reflétés dans l’API external_content_type et external_content_source. Consultez API Recherche fédérée Zendesk - Référence.
Vous pouvez configurer vos résultats de recherche pour inclure ou exclure les sources de contenu externe. Quand du contenu externe est inclus dans une recherche du centre d’aide, les filtres de recherche regroupent ce contenu par noms de source et de type, pour aider les utilisateurs à trouver plus facilement le contenu dont ils ont besoin. La source regroupe le contenu par point d’origine (par exemple, blog) et le type regroupe le contenu par type de contenu (par exemple, documentation pour les développeurs).
Réfléchissez à des regroupements et des noms utiles pour vos sources et vos types de contenu externe au moment de leur création : cela aidera les utilisateurs finaux à facilement filtrer et trouver le contenu qu’ils recherchent dans votre centre d’aide. Consultez Modification des filtres de recherche.
Limites connues pour la recherche fédérée
À l’heure actuelle, voici les limitations connues de la recherche fédérée :
- Les résultats de recherche incluant du contenu externe s’affichent dans les recherches du centre d’aide, dans la section Connaissances du volet contextuel et dans les réponses de l’API Recherche unifiée. Ils ne s’affichent pas dans les autres interfaces Guide basées sur la recherche, comme la recherche instantanée ou l’API Recherche d’articles.
- Le crawler de recherche ne fonctionne pas avec les sites Web qui utilisent le code de compression de fichiers gzip. Vous ne verrez pas de résultats de recherche provenant de ces sites.
- Le crawler de recherche ne respectera pas de délai de recherche (crawl-delay) s'il est défini pour les enregistrements robots.txt d'un site externe.