Gmail

Gmail est un client de messagerie développé par Google grâce auquel vous pouvez envoyer des e-mails avec des pièces jointes. Les messages Gmail peuvent être triés et stockés dans votre boîte de réception à l'aide de dossiers et d'étiquettes. Vous pouvez l'utiliser Amazon Kendra pour indexer vos e-mails et vos pièces jointes. Vous pouvez également configurer Amazon Kendra pour inclure ou exclure des e-mails, des pièces jointes et des étiquettes spécifiques à des fins d'indexation.

Vous pouvez vous connecter Amazon Kendra à votre source de données Gmail à 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 Gmail, consultezDépannage des sources de données.

Fonctionnalités prises en charge

• Mappages de champs

• Contrôle d'accès des utilisateurs

• Filtres d'inclusion/exclusion

• Synchronisation complète et incrémentielle du contenu

• Cloud privé virtuel (VPC)

Prérequis

Avant de pouvoir Amazon Kendra indexer votre source de données Gmail, apportez ces modifications à votre compte Gmail et à vos AWS comptes.

Dans Gmail, assurez-vous que vous disposez des éléments suivants :

• J'ai créé un compte administrateur Google Cloud Platform et j'ai créé un projet Google Cloud.

• Vous avez activé l'API Gmail et l'API Admin SDK dans votre compte administrateur.

• Vous avez créé un compte de service et téléchargé une clé privée JSON pour votre compte Gmail. Pour plus d'informations sur la création et l'accès à votre clé privée, consultez la documentation de Google Cloud sur la création d'une clé de compte de service et les informations d'identification du compte de service.

• Vous avez copié l'adresse e-mail de votre compte administrateur, celle de votre compte de service et votre clé privée pour les utiliser comme informations d'authentification.

  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).

• Les étendues Oauth suivantes (en utilisant un rôle d'administrateur) ont été ajoutées pour votre utilisateur et les répertoires partagés que vous souhaitez indexer :

  • https://www.googleapis.com/auth/admin.directory.user.readonly

  • https://www.googleapis.com/auth/gmail.readonly

• Il est vérifié que chaque document est unique dans Gmail 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. IDs Les documents sont globaux par rapport à 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 Gmail 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 Gmail à 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 Gmail, vous devez fournir les détails de vos informations d'identification Gmail afin de Amazon Kendra pouvoir accéder à vos données. Si vous n'avez pas encore configuré Gmail pour Amazon Kendra, consultezPrérequis.

Console

Pour vous connecter Amazon Kendra à Gmail

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 Gmail, puis sélectionnez Ajouter un connecteur. Si vous utilisez la version 2 (le cas échéant), choisissez le connecteur Gmail 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. 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.

   2. Dans Authentification pour le AWS Secrets Manager secret : choisissez un secret existant ou créez-en un nouveau Secrets Manager pour stocker vos informations d'authentification Gmail. 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.

         2. Adresse e-mail du client : adresse e-mail du client que vous avez copiée depuis votre compte de service Google.

         3. Adresse e-mail du compte administrateur : adresse e-mail du compte administrateur que vous souhaitez utiliser.

         4. Clé privée : clé privée que vous avez copiée depuis votre compte de service Google.

         5. Enregistrez et ajoutez votre secret.

   3. 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.

   4. 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.

   5. Choisissez Suivant.

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

   1. Pour les types d'entités : choisissez de synchroniser les pièces jointes des messages.

   2. (Facultatif) Pour Configuration supplémentaire, entrez les informations suivantes :

      1. Plage de dates : entrez une plage de dates pour spécifier les dates de début et de fin des e-mails que vous souhaitez analyser.

      2. Domaines de messagerie : incluez ou excluez certains e-mails en fonction des domaines de messagerie « à », « de », « cc » et « bcc ».

      3. Mots clés dans les sujets : incluez ou excluez les e-mails en fonction des mots clés figurant dans leur objet.

         Note

         Vous pouvez également choisir d'inclure tous les documents correspondant à tous les mots clés du sujet que vous avez saisis.

      4. Étiquettes : ajoutez des modèles d'expressions régulières pour inclure ou exclure certaines étiquettes d'e-mail.

      5. Pièces jointes : ajoutez des modèles d'expressions régulières pour inclure ou exclure certaines pièces jointes à des e-mails.

   3. 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.

      • 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.

      Important

      Comme il n'existe aucune API permettant de mettre à jour les messages Gmail définitivement supprimés, les contenus nouveaux, modifiés ou supprimés sont synchronisés :

      • Ne supprimera pas de votre Amazon Kendra index les messages définitivement supprimés de Gmail

      • Ne synchronisera pas les modifications dans les libellés des e-mails Gmail

      Pour synchroniser les modifications apportées à l'étiquette de votre source de données Gmail et les e-mails définitivement supprimés avec votre Amazon Kendra index, vous devez effectuer régulièrement des analyses complètes.

   4. Dans Calendrier d'exécution de la synchronisation, pour Fréquence : choisissez la fréquence à laquelle vous souhaitez synchroniser le contenu de votre source de données et mettre à jour votre index.

   5. 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.

      Note

      Amazon Kendra Le connecteur de source de données Gmail ne prend pas en charge la création de champs d'index personnalisés en raison des limites de l'API.

   2. 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 à Gmail

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

• Source de données —Spécifiez le type de source de données GMAIL lorsque vous utilisez le TemplateConfigurationSchéma JSON. Spécifiez également la source de données comme TEMPLATE lorsque vous appelez le CreateDataSourceAPI.

• Mode de synchronisation : spécifiez comment Amazon Kendra 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. Vous pouvez choisir entre :

  • FORCED_FULL_CRAWLpour indexer à nouveau tout le contenu, en remplaçant le contenu existant chaque fois que votre source de données se synchronise avec votre index.

  • FULL_CRAWLpour indexer 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.

  Important

  Comme il n'existe aucune API permettant de mettre à jour les messages Gmail définitivement supprimés, les contenus nouveaux, modifiés ou supprimés sont synchronisés :

  • Ne supprimera pas de votre Amazon Kendra index les messages définitivement supprimés de Gmail

  • Ne synchronisera pas les modifications dans les libellés des e-mails Gmail

  Pour synchroniser les modifications apportées à l'étiquette de votre source de données Gmail et les e-mails définitivement supprimés avec votre Amazon Kendra index, vous devez effectuer régulièrement des analyses complètes.

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

  {
      "adminAccountEmailId": "service account email",
      "clientEmailId": "user account email",
      "privateKey": "private key"
  }

• 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 le public requis APIs pour le connecteur Gmail et Amazon Kendra. Pour plus d'informations, consultez la section IAM Rôles des sources de données Gmail.

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

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

• Filtres d'inclusion et d'exclusion : indiquez s'il faut inclure ou exclure certains e-mails « à », « de », « cc » ou « bcc ».

  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 Gmail à vos champs d' Amazon Kendra 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.

  Note

  Amazon Kendra Le connecteur de source de données Gmail ne prend pas en charge la création de champs d'index personnalisés en raison des limites de l'API.

Pour obtenir la liste des autres clés JSON importantes à configurer, voir Gmail schéma de modèle.

En savoir plus

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

• Effectuez une recherche intelligente dans les e-mails de votre espace de travail Google à l'aide du connecteur Gmail pour Amazon Kendra.

Remarques

• Comme il n'existe aucune API permettant de mettre à jour les messages Gmail définitivement supprimés, une synchronisation de contenuFULL_CRAWL/Nouveau, modifié ou supprimé :

  • Ne supprimera pas de votre Amazon Kendra index les messages définitivement supprimés de Gmail

  • Ne synchronisera pas les modifications dans les libellés des e-mails Gmail

  Pour synchroniser les modifications apportées à l'étiquette de votre source de données Gmail et les e-mails définitivement supprimés avec votre Amazon Kendra index, vous devez effectuer régulièrement des analyses complètes.

• Amazon Kendra Le connecteur de source de données Gmail ne prend pas en charge la création de champs d'index personnalisés en raison des limites de l'API.