Drupal - Amazon Kendra

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.

Drupal

Drupal est un système de gestion de contenu (CMS) open source que vous pouvez utiliser pour créer des sites Web et des applications Web. Vous pouvez l'utiliser Amazon Kendra pour indexer les éléments suivants dans Drupal :

  • Contenu : articles, pages de base, blocs de base, types de contenu définis par l'utilisateur, types de blocs définis par l'utilisateur, types de contenu personnalisés, types de blocs personnalisés

  • Commentaire : pour tous les types de contenu et de bloc

  • Pièces jointes : pour tous les types de contenu et de blocs

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

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

Fonctionnalités prises en charge

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

  • Mappages de champs

  • Filtrage du contexte utilisateur

  • 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 Drupal, apportez ces modifications à votre Drupal et à vos comptes. AWS

Dans Drupal, assurez-vous d'avoir :

  • Création d'un compte Drupal (Standard) Suite et d'un utilisateur doté d'un rôle d'administrateur.

  • Vous avez copié le nom de votre site Drupal et configuré une URL d'hôte. Par exemple, https :///<hostname><drupalsitename>.

  • Identifiants d'authentification de base configurés contenant un nom d'utilisateur (nom d'utilisateur de connexion au site Web Drupal) et un mot de passe (mot de passe du site Web Drupal).

  • Recommandé : configuration d'un jeton d'identification OAuth 2.0. Utilisez ce jeton avec votre mot de passe Drupal, votre identifiant client, votre secret client, votre nom d'utilisateur (nom d'utilisateur de connexion au site Web Drupal) et votre mot de passe (mot de passe du site Web Drupal) pour vous connecter à. Amazon Kendra

  • Vous avez ajouté les autorisations suivantes à votre compte Drupal à l'aide d'un rôle d'administrateur :

    • administrer des blocs

    • administrer l'affichage de block_content

    • administrer les champs block_content

    • administrer l'affichage du formulaire block_content

    • administrer les vues

    • afficher les adresses e-mail des utilisateurs

    • voir son propre contenu non publié

    • voir les révisions de page

    • voir les révisions des articles

    • voir toutes les révisions

    • voir le thème de l'administration

    • accéder au contenu

    • aperçu du contenu d'accès

    • accéder aux commentaires

    • contenu de recherche

    • aperçu des fichiers d'accès

    • accéder aux liens contextuels

    Note

    S'il existe des types de contenu définis par l'utilisateur ou des types de blocs définis par l'utilisateur, ou si des vues et des blocs sont ajoutés au site Web Drupal, ils doivent disposer d'un accès administrateur.

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 Drupal 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 Drupal à. 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 Drupal, vous devez fournir les détails de vos informations d'identification Drupal afin de Amazon Kendra pouvoir accéder à vos données. Si vous n'avez pas encore configuré Drupal pour Amazon Kendra voir. Prérequis

Console

Pour vous connecter Amazon Kendra à Drupal

  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 Drupal, puis sélectionnez Ajouter un connecteur. Si vous utilisez la version 2 (le cas échéant), choisissez le connecteur Drupal avec le tag « 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 tirets, 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. Dans Source, pour URL hôte : URL hôte de votre site Drupal. Par exemple, https :///<hostname><drupalsitename>.

    2. Pour l'emplacement du certificat SSL : entrez le chemin d'accès au certificat SSL stocké dans votre Amazon S3 compartiment.

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

    4. Pour l'authentification : choisissez entre l'authentification de base et l'authentification OAuth 2.0 en fonction de votre cas d'utilisation.

    5. AWS Secrets Manager secret —Choisissez un secret existant ou créez-en un nouveau Secrets Manager pour stocker vos informations d'authentification Drupal. 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. Si vous avez choisi l'authentification de base, entrez le nom secret, le nom d'utilisateur (nom d'utilisateur du site Drupal) et le mot de passe (mot de passe du site Drupal) que vous avez copiés, puis choisissez Enregistrer et ajouter un secret.

        2. Si vous avez choisi l'authentification OAuth 2.0, entrez un nom secret, un nom d'utilisateur (nom d'utilisateur du site Drupal), un mot de passe (mot de passe du site Drupal), un identifiant client et un secret client générés dans votre compte Drupal, puis choisissez Enregistrer et ajouter un secret.

      2. Choisissez Enregistrer.

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

    7. 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. Sinon, si le robot d'identification est désactivé, tous les documents peuvent être consultés publiquement. 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.

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

    9. Choisissez Suivant.

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

    1. Pour l'étendue de la synchronisation, choisissez l'une des options suivantes :

      Note

      Lorsque vous choisissez d'explorer les articles, les pages de base et les blocs de base, leurs champs par défaut sont automatiquement synchronisés. Vous pouvez également choisir de synchroniser leurs commentaires, pièces jointes, champs personnalisés et autres entités personnalisées.

      1. Pour les entités Select :

        • Articles : choisissez d'explorer les articles, leurs commentaires, leurs commentaires et leurs pièces jointes.

        • Pages de base : choisissez si vous souhaitez explorer les pages de base, leurs commentaires et leurs pièces jointes.

        • Blocs de base : choisissez d'explorer les blocs de base, leurs commentaires et leurs pièces jointes.

        • Vous pouvez également choisir d'ajouter des types de contenu personnalisés et des blocs personnalisés.

    2. Pour une configuration supplémentaire, optionnelle :

      • Pour le modèle Regex : ajoutez des modèles d'expressions régulières pour inclure ou exclure des titres d'entités et des noms de fichiers spécifiques. Vous pouvez ajouter jusqu'à 100 motifs.

    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.

    4. Dans Synchroniser le calendrier d'exécution, Fréquence : fréquence Amazon Kendra de synchronisation avec votre source de données.

    5. Choisissez Suivant.

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

    1. Pour le contenu, les commentaires et les pièces jointes : 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 depuis cette page. Votre source de données apparaîtra sur la page Sources de données une fois que la source de données aura été ajoutée avec succès.

API

Pour vous connecter Amazon Kendra à Drupal

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 DRUPAL lorsque vous utilisez le schéma TemplateConfigurationJSON. Spécifiez également la source de données TEMPLATE lorsque vous appelez l'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.

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

  • Nom de ressource Amazon secret (ARN) : fournissez le nom de ressource Amazon (ARN) d'un Secrets Manager secret contenant les informations d'authentification que vous avez créées dans votre compte Drupal.

    Si vous utilisez l'authentification de base, le secret est stocké dans une structure JSON avec les clés suivantes :

    { "username": "user name", "password": "password" }

    Si vous utilisez l'authentification OAuth 2.0, le secret est stocké dans une structure JSON avec les clés suivantes :

    { "username": "user name", "password": "password", "clientId": "client id", "clientSecret": "client secret" }
    Note
    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).

  • 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 pour appeler les API publiques requises pour le connecteur Drupal et. Amazon Kendra Pour plus d'informations, consultez la section IAM Rôles des sources de données Drupal.

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.

  • Filtres d'inclusion et d'exclusion : vous pouvez indiquer si vous souhaitez inclure le contenu, les commentaires et les pièces jointes. Vous pouvez également spécifier des modèles d'expressions régulières pour inclure ou exclure du contenu, des commentaires et des pièces jointes.

    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.

  • 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. Sinon, si le robot d'identification est désactivé, tous les documents peuvent être consultés publiquement. 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.

  • Mappages de champs : choisissez de mapper les champs de votre source de données Drupal à vos champs d'index. Amazon Kendra 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, consultezSchéma du modèle Drupal.

Remarques

  • Les API Drupal n'ont aucune limite de régulation officielle.

  • Les SDK Java ne sont pas disponibles pour Drupal.

  • Les données Drupal ne peuvent être récupérées qu'à l'aide des API JSON natives.

  • Les types de contenu qui ne sont associés à aucune vue Drupal ne peuvent pas être analysés.

  • Vous devez disposer d'un accès administrateur pour analyser les données de Drupal Blocks.

  • Aucune API JSON n'est disponible pour créer le type de contenu défini par l'utilisateur à l'aide de verbes HTTP.

  • Le corps du document et les commentaires relatifs aux articles, aux pages de base, aux blocs de base, au type de contenu défini par l'utilisateur et au type de bloc défini par l'utilisateur sont affichés au format HTML. Si le contenu HTML n'est pas bien formé, les balises associées au HTML apparaîtront dans le corps du document et dans les commentaires et seront visibles dans les résultats Amazon Kendra de recherche.

  • Les types de contenu et les types de blocs sans description ni corps ne seront pas ingérés. Amazon Kendra Seuls les commentaires et les pièces jointes de ce type de contenu ou de bloc seront ingérés dans votre Amazon Kendra index.