View a markdown version of this page

SharePoint connecteur V1.0 - Amazon Kendra
Fonctionnalités prises en chargeConditions préalablesInstructions de connexionEn savoir plus

Amazon Kendra n'est plus ouvert aux nouveaux clients. Pour des fonctionnalités similaires à Amazon Kendra, explorez les bases de connaissances Amazon Bedrock. En 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.

SharePoint connecteur V1.0

SharePoint est un service collaboratif de création de sites Web que vous pouvez utiliser pour personnaliser le contenu Web et créer des pages, des sites, des bibliothèques de documents et des listes. Si vous êtes un SharePoint utilisateur, vous pouvez l'utiliser Amazon Kendra pour indexer votre source de SharePoint données.

Note

SharePoint connecteur V1.0 / SharePointConfiguration API a pris fin en 2023. Nous vous recommandons de migrer vers ou d'utiliser un SharePoint V2.0 TemplateConfiguration connecteur/API.

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

Fonctionnalités prises en charge

  • Mappages de champs

  • Contrôle d'accès des utilisateurs

  • Inclusion/exclusion filtres

  • Journal des modifications

  • Cloud privé virtuel (VPC)

Conditions préalables

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

Vous devez fournir des informations d'authentification, que vous stockez de manière sécurisée et AWS Secrets Manager secrète.

Note

Nous vous recommandons d’actualiser ou de modifier régulièrement vos informations d’identification et votre secret. Pour votre propre sécurité, fournissez uniquement le niveau d’accès nécessaire. 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).

Dans SharePoint, assurez-vous d'avoir :

  • Notez l'URL des SharePoint sites que vous souhaitez indexer.

  • Pour SharePoint en ligne :

    • Vous avez pris note de vos informations d'authentification de base contenant un nom d'utilisateur et un mot de passe avec des autorisations d'administrateur du site.

    • Facultatif : informations d'identification OAuth 2.0 générées contenant un nom d'utilisateur, un mot de passe, un ID client et un secret client.

    • Désactivé les paramètres de sécurité par défaut sur votre portail Azure à l’aide d’un utilisateur administratif. Pour plus d'informations sur la gestion des paramètres de sécurité par défaut dans le portail Azure, consultez la documentation Microsoft sur la procédure à suivre pour définir les paramètres enable/disable de sécurité par défaut.

  • Pour le SharePoint serveur :

    • Notez le nom de domaine de votre SharePoint serveur (le nom NetBIOS dans votre Active Directory). Vous l'utilisez, ainsi que votre nom d'utilisateur et votre mot de passe d'authentification de SharePoint base, pour vous connecter au SharePoint serveur Amazon Kendra.

    Note

    Si vous utilisez SharePoint Server et que vous devez convertir votre liste de contrôle d'accès (ACL) au format e-mail pour filtrer en fonction du contexte utilisateur, fournissez l'URL du serveur LDAP et la base de recherche LDAP. Vous pouvez également utiliser le remplacement du domaine du répertoire. L'URL du serveur LDAP est le nom de domaine complet et le numéro de port (par exemple, ldap : //example.com:389). La base de recherche LDAP est constituée des contrôleurs de domaine « example » et « com ». Avec le remplacement du domaine de répertoire, vous pouvez utiliser le domaine de messagerie au lieu d'utiliser l'URL du serveur LDAP et la base de recherche LDAP. Par exemple, le domaine de messagerie de username@example.com est « example.com ». Vous pouvez utiliser cette dérogation si la validation de votre domaine ne vous préoccupe pas et que vous souhaitez simplement utiliser votre domaine de messagerie.

  • Les autorisations suivantes ont été ajoutées à votre SharePoint compte :

    Pour les SharePoint listes

    • Éléments ouverts : affichez la source des documents à l'aide de gestionnaires de fichiers côté serveur.

    • Afficher les pages de candidature : affiche les formulaires, les vues et les pages de candidature. Énumérez des listes.

    • Afficher les éléments : affiche les éléments dans les listes et les documents dans les bibliothèques de documents.

    • Afficher les versions : affiche les versions précédentes d'un élément de liste ou d'un document.

    Pour les SharePoint sites Web

    • Parcourir les répertoires : énumérez les fichiers et les dossiers d'un site Web à l'aide de SharePoint Designer et de l'interface Web DAV.

    • Parcourir les informations utilisateur : affiche les informations relatives aux utilisateurs du site Web.

    • Énumérer les autorisations : énumère les autorisations sur le site Web, la liste, le dossier, le document ou l'élément de liste.

    • Ouvrir : ouvrez un site Web, une liste ou un dossier pour accéder aux éléments contenus dans le conteneur.

    • Utiliser les fonctionnalités d'intégration client : utilisez SOAP, WebDAV, le modèle objet client ou les interfaces SharePoint Designer pour accéder au site Web.

    • Utiliser les interfaces distantes : utilisez les fonctionnalités qui lancent les applications clientes.

    • Afficher les pages : permet d'afficher les pages d'un site Web.

  • Coché : chaque document est unique dans SharePoint et entre 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 ID de document sont globaux pour un index et doivent être uniques par index.

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

  • A créé un Amazon Kendra index et, si vous utilisez l'API, en avez noté l'ID.

  • 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 à l'ID AWS Secrets Manager secret correct.

  • Vous avez enregistré vos informations d' SharePoint authentification 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 secret. Pour votre propre sécurité, fournissez uniquement le niveau d’accès nécessaire. 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 SharePoint données à 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 ID d'index.

Instructions de connexion

Pour vous connecter Amazon Kendra à votre source de SharePoint données, vous devez fournir les détails de vos SharePoint informations d'identification afin de Amazon Kendra pouvoir accéder à vos données. Si vous n'avez pas encore configuré SharePoint pour Amazon Kendra voirConditions préalables.

Console

Pour vous connecter Amazon Kendra à SharePoint

  1. Connectez-vous à la console AWS de gestion et ouvrez la Amazon Kendra console.

  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 Paramètres d'index.

  3. Sur la page Mise en route, choisissez Ajouter une source de données.

  4. Sur la page Ajouter une source de données, choisissez SharePoint Connector v1.0, puis choisissez Ajouter une source de données.

  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 un nom pour 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 en vue de l'index. Sauf indication contraire de votre part, 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 Tags, pour Ajouter une nouvelle étiquette  : 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. Pour la méthode d'hébergement  : choisissez entre SharePoint En ligne et SharePoint Serveur.

      1. Pour les sites SharePoint en ligne : entrez les URL des sites spécifiques à votre SharePoint référentiel.

      2. Pour le SharePoint serveur  : choisissez votre SharePoint version, entrez les URL des sites spécifiques à votre SharePoint référentiel et saisissez le Amazon S3 chemin d'accès à l'emplacement de votre certificat SSL.

    2. (SharePoint Serveur uniquement) Pour le proxy Web  : entrez le nom d'hôte et le numéro de port de votre SharePoint instance interne. Le numéro de port doit être une valeur numérique comprise entre 0 et 65 535.

    3. Pour l'authentification  : choisissez l'une des options suivantes en fonction de votre cas d'utilisation :

      1. Pour SharePoint en ligne : choisissez entre l'authentification de base et l'authentification OAuth 2.0.

      2. Pour le SharePoint serveur : choisissez entre Aucun, LDAP et Manuel.

    4. Pour le AWS Secrets Manager secret  : choisissez un secret existant ou créez-en un nouveau Secrets Manager pour stocker vos informations SharePoint d'authentification. Si vous choisissez de créer un nouveau secret, une fenêtre AWS Secrets Manager secrète s'ouvre. Vous devez saisir un nom secret. Le préfixe « AmazonKendra-SharePoint - » est automatiquement ajouté à votre nom secret.

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

      1. Choisissez parmi les options d'authentification SharePoint dans le cloud suivantes, en fonction de votre cas d'utilisation :

        1. Authentification de base  : entrez le nom d'utilisateur de votre SharePoint compte comme nom d'utilisateur et le mot de passe du SharePoint compte comme mot de passe.

        2. Authentification OAuth 2.0  : entrez le nom d'utilisateur de votre SharePoint compte comme nom d'utilisateur, le mot de passe du SharePoint compte comme mot de passe, votre SharePoint identifiant unique généré automatiquement comme identifiant client et la chaîne secrète partagée utilisée par les deux SharePoint et Amazon Kendra comme secret client.

      2. Choisissez l'une des options d'authentification SharePoint du serveur suivantes, en fonction de votre cas d'utilisation :

        1. Aucun  : entrez le nom d'utilisateur de votre SharePoint compte comme nom d'utilisateur, le mot de passe de votre SharePoint compte comme mot de passe et le nom de domaine de votre serveur.

        2. LDAP —Entrez le nom d'utilisateur de votre SharePoint compte comme nom d'utilisateur, le mot de passe du SharePoint compte comme mot de passe, votre point de terminaison du serveur LDAP (y compris le numéro de protocole et de port, par exempleldap://example.com:389) et votre base de recherche LDAP (par exemple,). dc=example, dc=com

        3. Manuel  : entrez le nom d'utilisateur de votre SharePoint compte comme nom d'utilisateur, le mot de passe de votre SharePoint compte comme mot de passe et votre remplacement de domaine de messagerie (domaine de messagerie de l'utilisateur ou du groupe du répertoire).

      3. Choisissez Enregistrer.

    6. Virtual Private Cloud (VPC)  : vous devez également ajouter des sous-réseaux et des groupes de sécurité VPC.

      Note

      Vous devez utiliser un VPC si vous utilisez SharePoint Server. Amazon VPC est facultatif pour les autres SharePoint versions.

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

    8. Choisissez Suivant.

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

    1. Utiliser le journal des modifications  : sélectionnez cette option pour mettre à jour votre index au lieu de synchroniser tous vos fichiers.

    2. Analyser les pièces jointes  : sélectionnez cette option pour analyser les pièces jointes.

    3. Utiliser les mappages de groupes locaux  : sélectionnez cette option pour vous assurer que les documents sont correctement filtrés.

    4. Configuration supplémentaire  : ajoutez des modèles d'expressions régulières pour inclure ou exclure certains fichiers. Vous pouvez ajouter jusqu’à 100 modèles.

    5. Dans Synchroniser, exécutez le calendrier pour Frequency : à quelle fréquence Amazon Kendra se synchronisera avec votre source de données.

    6. Choisissez Suivant.

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

    1. Amazon Kendra mappages de champs 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. Pour les mappages de champs personnalisés  : ajoutez des champs de source de données personnalisés pour 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 que vous avez 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 à SharePoint

Vous devez spécifier les éléments suivants à l'aide de l'SharePointConfigurationAPI :

  • SharePointVersion  : spécifiez la SharePoint version que vous utilisez lors de la configuration SharePoint. C'est le cas, que vous utilisiez SharePoint Server 2013, SharePoint Server Subscription Edition ou SharePoint Online.

  • Nom de ressource Amazon secret (ARN)  : indiquez le nom de ressource Amazon (ARN) d'un Secrets Manager secret contenant les informations d'authentification que vous avez créées dans votre SharePoint compte. Le secret est stocké dans une structure JSON.

    Pour l'authentification de base SharePoint en ligne, voici la structure JSON minimale qui doit figurer dans votre code secret :

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

    Pour l'authentification OAuth 2.0 SharePoint en ligne, voici la structure JSON minimale qui doit figurer dans votre code secret :

    {
    "userName": "SharePoint account user name"",
    "password": "SharePoint account password",
    "clientId": "SharePoint auto-generated unique client id",
    "clientSecret": "secret string shared by Amazon Kendra and SharePoint to authorize communications"
}

    Pour l'authentification de base du SharePoint serveur, voici la structure JSON minimale qui doit figurer dans votre code secret :

    {
    "userName": "user name",
    "password": "password",
    "domain": "server domain name"
}

    Pour l'authentification LDAP SharePoint du serveur (si vous devez convertir votre liste de contrôle d'accès (ACL) au format e-mail pour filtrer le contexte utilisateur, vous pouvez inclure l'URL du serveur LDAP et la base de recherche LDAP dans votre secret), voici la structure JSON minimale qui doit figurer dans votre secret :

    {
    "userName": "user name",
    "password": "password",
    "domain": "server domain name"
    "ldapServerUrl": "ldap://example.com:389",
    "ldapSearchBase": "dc=example,dc=com"
}

    Pour l'authentification manuelle du SharePoint serveur, voici la structure JSON minimale qui doit figurer dans votre code secret :

    {
    "userName": "user name",
    "password": "password",
    "domain": "server domain name",
    "emailDomainOverride": "example.com"
}

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

  • Amazon VPC—Si vous utilisez SharePoint Server, spécifiez-le dans VpcConfiguration le cadre de la configuration de la source de données. Consultez la section Configuration Amazon Kendra pour utiliser un VPC.

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

  • Proxy Web  : s'il faut se connecter aux URL de votre SharePoint site via un proxy Web. Vous ne pouvez utiliser cette option que pour le SharePoint serveur.

  • Listes d'indexation  : s'il Amazon Kendra faut indexer le contenu des pièces jointes pour SharePoint répertorier les éléments.

  • Journal des modifications  : s'il Amazon Kendra faut utiliser le mécanisme du journal des modifications de la source de SharePoint données 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 SharePoint données peut prendre Amazon Kendra moins de temps que le traitement du journal des modifications. Si vous synchronisez votre source de données SharePoint avec votre index pour la première fois, tous les documents sont numérisés.

  • Filtres d'inclusion et d'exclusion  : vous pouvez spécifier si vous souhaitez inclure ou exclure certains contenus.

    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 qui correspondent au filtre d'exclusion ne sont pas indexés, même s'ils correspondent au filtre d'inclusion.

  • Mappages de champs  : choisissez de mapper vos champs de source de SharePoint données à vos champs d' Amazon Kendra index. Pour plus d’informations, consultez 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 obligatoire pour Amazon Kendra effectuer une recherche dans vos documents. Vous devez associer le nom du champ du corps de votre document dans votre source de données au nom du champ d'index_document_body. Tous les autres champs sont facultatifs.

  • Filtrage du contexte utilisateur et contrôle d'Amazon Kendra accès  : analyse la liste de contrôle d'accès (ACL) de vos documents, si vous en avez une. 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 contextuel des utilisateurs.

En savoir plus

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