Zendesk - Amazon Kendra
Fonctionnalités prises en chargePrérequisInstructions de connexionEn savoir plus

Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.

Zendesk

Zendesk est un système de gestion de la relation client qui aide les entreprises à automatiser et à améliorer les interactions avec le service client. Vous pouvez l'utiliser Amazon Kendra pour indexer vos tickets d'assistance Zendesk, les commentaires sur les tickets, les pièces jointes aux tickets, les articles du centre d'aide, les commentaires d'articles, les pièces jointes aux commentaires d'articles, les sujets de la communauté des guides, les publications communautaires et les commentaires des publications communautaires.

Vous pouvez filtrer par nom d'organisation si vous souhaitez indexer les tickets qui concernent uniquement une organisation spécifique. Vous pouvez également choisir de définir une date d'exploration à laquelle vous souhaitez commencer à explorer les données de Zendesk.

Vous pouvez vous connecter Amazon Kendra à votre source de données Zendesk à l'aide de la Amazon Kendra console et de l'TemplateConfigurationAPI.

Pour résoudre les problèmes liés à votre connecteur de source de données Amazon Kendra Zendesk, consultezDépannage des sources de données.

Fonctionnalités prises en charge

Amazon Kendra Le connecteur de source de données Zendesk prend en charge les fonctionnalités suivantes :

  • Mappages de champs

  • Contrôle d'accès des utilisateurs

  • Filtres d'inclusion/exclusion

  • Journal des modifications, synchronisation complète et incrémentielle du contenu

  • Cloud privé virtuel (VPC)

Prérequis

Avant de pouvoir l'utiliser Amazon Kendra pour indexer votre source de données Zendesk, apportez ces modifications à votre Zendesk et AWS à vos comptes.

Dans Zendesk, assurez-vous d'avoir :

  • Création d'un compte administratif Zendesk Suite (Professional/Enterprise).

  • Vous avez noté l'URL de votre hôte Zendesk. Par exemple, https://{sub-domain}.zendesk.com/.

    Note

    (Sur place/sur serveur) Amazon Kendra vérifie si les informations de point de terminaison incluses sont les mêmes AWS Secrets Manager que celles spécifiées dans les détails de configuration de votre source de données. Cela permet de se protéger contre le problème de confusion des adjoints, qui est un problème de sécurité lorsqu'un utilisateur n'est pas autorisé à effectuer une action mais l'utilise Amazon Kendra comme proxy pour accéder au secret configuré et exécuter l'action. Si vous modifiez ultérieurement les informations de votre point de terminaison, vous devez créer un nouveau secret pour synchroniser ces informations.

  • Configuré un jeton OAuth 2.0 contenant un identifiant client, un secret client, un nom d'utilisateur et un mot de passe. Le jeton OAuth 2.0 doit être utilisé comme identifiant d'authentification. Consultez la documentation Zendesk sur la configuration des jetons OAuth 2.0 pour plus d'informations.

    Note

    Nous vous recommandons d'actualiser ou de modifier régulièrement vos informations d'identification et votre code secret. Fournissez uniquement le niveau d'accès nécessaire pour votre propre sécurité. Nous vous déconseillons de réutiliser les informations d'identification et les secrets entre les sources de données et les versions 1.0 et 2.0 du connecteur (le cas échéant).

  • La portée OAuth 2.0 suivante a été ajoutée :

    • lire

  • Facultatif : un certificat SSL a été installé Amazon Kendra pour permettre la connexion.

  • Il est vérifié que chaque document est unique dans Zendesk et dans les autres sources de données que vous prévoyez d'utiliser pour le même index. Chaque source de données que vous souhaitez utiliser pour un index ne doit pas contenir le même document dans toutes les sources de données. Les identifiants de document sont globaux à un index et doivent être uniques par index.

Dans votre Compte AWS, assurez-vous d'avoir :

  • Création d'un Amazon Kendra index et, si vous utilisez l'API, notez l'ID de l'index.

  • Vous avez créé un IAM rôle pour votre source de données et, si vous utilisez l'API, notez l'ARN du IAM rôle.

    Note

    Si vous modifiez votre type d'authentification et vos informations d'identification, vous devez mettre à jour votre IAM rôle pour accéder au bon identifiant AWS Secrets Manager secret.

  • Stockez vos informations d'authentification Zendesk dans un AWS Secrets Manager secret et, si vous utilisez l'API, notez l'ARN du secret.

    Note

    Nous vous recommandons d'actualiser ou de modifier régulièrement vos informations d'identification et votre code secret. Fournissez uniquement le niveau d'accès nécessaire pour votre propre sécurité. Nous vous déconseillons de réutiliser les informations d'identification et les secrets entre les sources de données et les versions 1.0 et 2.0 du connecteur (le cas échéant).

Si vous n'avez pas de IAM rôle ou de secret existant, vous pouvez utiliser la console pour créer un nouveau IAM rôle et un nouveau Secrets Manager secret lorsque vous connectez votre source de données Zendesk à Amazon Kendra. Si vous utilisez l'API, vous devez fournir l'ARN d'un IAM rôle et d'un Secrets Manager secret existants, ainsi qu'un identifiant d'index.

Instructions de connexion

Pour vous connecter Amazon Kendra à votre source de données Zendesk, vous devez fournir les informations nécessaires sur votre source de données Zendesk afin de Amazon Kendra pouvoir accéder à vos données. Si vous n'avez pas encore configuré Zendesk pour Amazon Kendra, consultezPrérequis.

Console

Pour vous connecter Amazon Kendra à Zendesk

  1. Connectez-vous à la Amazon Kendra console AWS Management Console et ouvrez-la.

  2. Dans le volet de navigation de gauche, choisissez Index, puis choisissez l'index que vous souhaitez utiliser dans la liste des index.

    Note

    Vous pouvez choisir de configurer ou de modifier vos paramètres de contrôle d'accès utilisateur dans les paramètres de l'index.

  3. Sur la page de démarrage, choisissez Ajouter une source de données.

  4. Sur la page Ajouter une source de données, choisissez le connecteur Zendesk, puis sélectionnez Ajouter un connecteur. Si vous utilisez la version 2 (le cas échéant), choisissez le connecteur Zendesk avec la balise « V2.0 ».

  5. Sur la page Spécifier les détails de la source de données, entrez les informations suivantes :

    1. Dans Nom et description, pour Nom de la source de données : entrez le nom de votre source de données. Vous pouvez inclure des traits d'union, mais pas des espaces.

    2. (Facultatif) Description : entrez une description facultative pour votre source de données.

    3. Dans la langue par défaut : choisissez une langue pour filtrer vos documents pour l'index. Sauf indication contraire, la langue par défaut est l'anglais. La langue spécifiée dans les métadonnées du document remplace la langue sélectionnée.

    4. Dans Balises, pour Ajouter une nouvelle balise : incluez des balises facultatives pour rechercher et filtrer vos ressources ou suivre vos AWS coûts.

    5. Choisissez Suivant.

  6. Sur la page Définir l'accès et la sécurité, entrez les informations suivantes :

    1. URL Zendesk —Entrez votre URL Zendesk. Par exemple, https://{sub-domain}.zendesk.com/.

    2. Autorisation : activez ou désactivez les informations de la liste de contrôle d'accès (ACL) pour vos documents, si vous disposez d'une ACL et que vous souhaitez l'utiliser pour le contrôle d'accès. L'ACL indique les documents auxquels les utilisateurs et les groupes peuvent accéder. Les informations ACL sont utilisées pour filtrer les résultats de recherche en fonction de l'accès de l'utilisateur ou de son groupe aux documents. Pour plus d'informations, consultez la section Filtrage du contexte utilisateur.

    3. AWS Secrets Manager secret —Choisissez un secret existant ou créez-en un nouveau Secrets Manager pour stocker vos informations d'authentification Zendesk. Si vous choisissez de créer un nouveau secret, une fenêtre AWS Secrets Manager secrète s'ouvre.

      1. Entrez les informations suivantes dans la fenêtre Créer un AWS Secrets Manager secret :

        1. Nom secret : le nom de votre secret. Le préfixe « AmazonKendra -Zendesk-» est automatiquement ajouté à votre nom secret.

        2. Pour l'ID client, le secret du client, le nom d'utilisateur, le mot de passe : entrez les valeurs d'identification d'authentification configurées dans Zendesk.

      2. Enregistrez et ajoutez votre secret.

    4. Virtual Private Cloud (VPC) —Vous pouvez choisir d'utiliser un VPC. Dans ce cas, vous devez ajouter des sous-réseaux et des groupes de sécurité VPC.

    5. Identity Crawler : spécifiez s'il faut activer l'explorateur Amazon Kendra d'identité. Le robot d'exploration d'identité utilise les informations de la liste de contrôle d'accès (ACL) de vos documents pour filtrer les résultats de recherche en fonction de l'accès de l'utilisateur ou de son groupe aux documents. Si vous disposez d'une ACL pour vos documents et que vous choisissez de l'utiliser, vous pouvez également choisir d'activer le robot d'exploration Amazon Kendra d'identité pour configurer le filtrage des résultats de recherche par contexte utilisateur. Dans le cas contraire, si Identity Crawler est désactivé, tous les documents peuvent faire l'objet d'une recherche publique. Si vous souhaitez utiliser le contrôle d'accès pour vos documents et que le robot d'exploration d'identité est désactivé, vous pouvez également utiliser l'PutPrincipalMappingAPI pour télécharger les informations d'accès des utilisateurs et des groupes afin de filtrer le contexte utilisateur.

    6. IAM rôle —Choisissez un IAM rôle existant ou créez-en un nouveau IAM pour accéder aux informations d'identification de votre référentiel et indexer le contenu.

      Note

      IAM les rôles utilisés pour les index ne peuvent pas être utilisés pour les sources de données. Si vous ne savez pas si un rôle existant est utilisé pour un index ou une FAQ, choisissez Créer un nouveau rôle pour éviter les erreurs.

    7. Choisissez Suivant.

  7. Sur la page Configurer les paramètres de synchronisation, entrez les informations suivantes :

    1. Sélectionnez le contenu : sélectionnez les types de contenu que vous souhaitez explorer à partir des tickets, des articles du centre d'aide, des sujets communautaires, etc.

    2. Nom de l'organisation : entrez les noms des organisations Zendesk pour filtrer le contenu.

    3. Date de début de synchronisation : entrez la date à partir de laquelle vous souhaitez commencer à analyser votre contenu.

    4. Modèles Regex : ajoutez des modèles d'expressions régulières pour inclure ou exclure certains fichiers. Vous pouvez ajouter jusqu'à 100 motifs.

    5. Mode de synchronisation : choisissez la manière dont vous souhaitez mettre à jour votre index lorsque le contenu de votre source de données change. Lorsque vous synchronisez votre source de données Amazon Kendra pour la première fois, tout le contenu est analysé et indexé par défaut. Vous devez exécuter une synchronisation complète de vos données en cas d'échec de la synchronisation initiale, même si vous ne choisissez pas l'option de synchronisation complète comme mode de synchronisation.

      • Synchronisation complète : Indexez tout le contenu fraîchement, en remplaçant le contenu existant chaque fois que votre source de données se synchronise avec votre index.

      • Nouvelle synchronisation modifiée : Indexez uniquement le contenu nouveau et modifié chaque fois que votre source de données se synchronise avec votre index. Amazon Kendra peut utiliser le mécanisme de votre source de données pour suivre les modifications de contenu et indexer le contenu modifié depuis la dernière synchronisation.

      • Synchronisation nouvelle, modifiée ou supprimée : Indexez uniquement le contenu nouveau, modifié et supprimé chaque fois que votre source de données se synchronise avec votre index. Amazon Kendra peut utiliser le mécanisme de votre source de données pour suivre les modifications de contenu et indexer le contenu modifié depuis la dernière synchronisation.

    6. Dans Synchroniser le calendrier d'exécution pour la fréquence : choisissez la fréquence à laquelle vous souhaitez synchroniser le contenu de votre source de données et mettre à jour votre index.

    7. Choisissez Suivant.

  8. Sur la page Définir les mappages de champs, entrez les informations suivantes :

    1. Champs de source de données par défaut : sélectionnez parmi les champs de source de données par défaut Amazon Kendra générés que vous souhaitez mapper à votre index.

    2. Ajouter un champ —Pour ajouter des champs de source de données personnalisés afin de créer un nom de champ d'index à mapper et le type de données du champ.

    3. Choisissez Suivant.

  9. Sur la page Réviser et créer, vérifiez que les informations saisies sont correctes, puis sélectionnez Ajouter une source de données. Vous pouvez également choisir de modifier vos informations à partir de cette page. Votre source de données apparaîtra sur la page Sources de données une fois qu'elle aura été ajoutée avec succès.

API

Pour vous connecter Amazon Kendra à Zendesk

Vous devez spécifier un JSON du schéma de source de données à l'aide de l'TemplateConfigurationAPI. Vous devez fournir les informations suivantes :

  • Source de données —Spécifiez le type de source de données tel que ZENDESK lorsque vous utilisez le schéma TemplateConfigurationJSON. Spécifiez également la source de données TEMPLATE lorsque vous appelez l'CreateDataSourceAPI.

  • URL de l'hôte : fournissez l'URL de votre hôte Zendesk dans le cadre de la configuration de la connexion ou des détails du point de terminaison du référentiel. Par exemple, https://yoursubdomain.zendesk.com.

  • Journal des modifications : Amazon Kendra faut-il utiliser le mécanisme du journal des modifications des sources de données Zendesk pour déterminer si un document doit être mis à jour dans l'index.

    Note

    Utilisez le journal des modifications si vous ne Amazon Kendra souhaitez pas numériser tous les documents. Si votre journal des modifications est volumineux, la numérisation des documents de la source de données Zendesk peut prendre Amazon Kendra moins de temps que le traitement du journal des modifications. Si vous synchronisez votre source de données Zendesk avec votre index pour la première fois, tous les documents sont numérisés.

  • Nom de ressource Amazon secret (ARN) : fournissez le nom de ressource Amazon (ARN) d'un Secrets Manager secret contenant les informations d'authentification de votre compte Zendesk. Le secret est stocké dans une structure JSON avec les clés suivantes :

    {
    "hostUrl": "https://yoursubdomain.zendesk.com",
    "clientId": "client ID",
    "clientSecret": "Zendesk client secret",
    "userName": "Zendesk user name",
    "password": "Zendesk password"
}

  • IAM role —Spécifiez à quel RoleArn moment vous appelez CreateDataSource pour fournir à un IAM rôle les autorisations d'accéder à votre Secrets Manager secret et d'appeler les API publiques requises pour le connecteur Zendesk et. Amazon Kendra Pour plus d'informations, consultez la section IAM Rôles pour les sources de données Zendesk.

Vous pouvez également ajouter les fonctionnalités optionnelles suivantes :

  • Virtual Private Cloud (VPC) VpcConfiguration —Spécifiez le moment de votre appel. CreateDataSource Pour plus d’informations, consultez Configuration Amazon Kendra pour utiliser un Amazon VPC.

  • Types de documents/contenus : spécifiez si vous souhaitez explorer :

    • Tickets d'assistance, commentaires sur les tickets et/ou pièces jointes aux commentaires sur les tickets

    • Articles du centre d'aide, pièces jointes aux articles et commentaires d'articles

    • Guidez les sujets, les publications ou les commentaires de la communauté

  • Filtres d'inclusion et d'exclusion : indiquez si vous souhaitez inclure ou exclure certains contenus de Slack. Si vous utilisez un jeton de bot dans le cadre de vos identifiants d'authentification Slack, vous devez ajouter le jeton de bot à la chaîne que vous souhaitez indexer. Vous ne pouvez pas indexer les messages directs et les messages de groupe à l'aide d'un jeton de bot.

    Note

    La plupart des sources de données utilisent des modèles d'expressions régulières, qui sont des modèles d'inclusion ou d'exclusion appelés filtres. Si vous spécifiez un filtre d'inclusion, seul le contenu correspondant au filtre d'inclusion est indexé. Tout document qui ne correspond pas au filtre d'inclusion n'est pas indexé. Si vous spécifiez un filtre d'inclusion et d'exclusion, les documents correspondant au filtre d'exclusion ne sont pas indexés, même s'ils correspondent au filtre d'inclusion.

  • Filtrage du contexte utilisateur et contrôle d'accèsAmazon Kendra  : analyse la liste de contrôle d'accès (ACL) de vos documents, si vous disposez d'une ACL pour vos documents. Les informations ACL sont utilisées pour filtrer les résultats de recherche en fonction de l'accès de l'utilisateur ou de son groupe aux documents. Pour plus d'informations, consultez la section Filtrage du contexte utilisateur.

  • Mappages de champs : choisissez de mapper les champs de votre source de données Zendesk à vos Amazon Kendra champs d'index. Pour plus d'informations, veuillez consulter la rubrique Mappage des champs de source de données.

    Note

    Le champ du corps du document ou l'équivalent du corps du document pour vos documents est requis pour Amazon Kendra effectuer une recherche dans vos documents. Vous devez associer le nom du champ du corps du document dans votre source de données au nom du champ d'index_document_body. Tous les autres champs sont facultatifs.

Pour obtenir la liste des autres clés JSON importantes à configurer, consultez le schéma du modèle Zendesk.

En savoir plus

Pour en savoir plus sur l'intégration Amazon Kendra à votre source de données Zendesk, consultez :