Box (Cube) - 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.

Box (Cube)

Box est un service de stockage dans le cloud qui offre des fonctionnalités d'hébergement de fichiers. Vous pouvez l'utiliser Amazon Kendra pour indexer le contenu de votre Box, notamment les commentaires, les tâches et les liens Web.

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

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

Fonctionnalités prises en charge

Amazon Kendra Le connecteur de source de données Box 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 Amazon Kendra indexer votre source de données Box, apportez ces modifications à votre Box et à vos AWS comptes.

Dans Box, assurez-vous d'avoir :

  • Un compte Box Enterprise ou Box Enterprise Plus.

  • Configuration d'une application personnalisée Box dans la Box Developer Console, avec authentification côté serveur à l'aide de jetons Web JSON (JWT). Consultez la documentation Box sur la création d'une application personnalisée et la documentation Box sur la configuration de JWT Auth pour plus de détails.

  • Définissez le niveau d'accès à votre application sur App + Enterprise Access et autorisez-le à effectuer des appels d'API à l'aide de l'en-tête as-user.

  • Vous avez utilisé l'utilisateur administrateur pour ajouter les champs d'application suivants dans votre application Box :

    • Écrire tous les fichiers et dossiers stockés dans une boîte

    • Gestion des utilisateurs

    • Gérer les groupes

    • Gérer les propriétés de l'entreprise

  • Paire de clés publique/privée configurée comprenant un identifiant client, un secret client, un identifiant de clé publique, un identifiant de clé privée, une phrase secrète et un identifiant d'entreprise à utiliser comme identifiants d'authentification. Consultez la section Paire de clés publiques et privées pour plus de détails.

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

  • Vous avez copié votre identifiant Box Enterprise depuis les paramètres de votre Box Developer Console ou depuis votre application Box. Par exemple, 801234567.

  • Coché : chaque document est unique dans Box 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 Box 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 Box à 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 Box, vous devez fournir les informations nécessaires sur votre source de données Box afin de Amazon Kendra pouvoir accéder à vos données. Si vous n'avez pas encore configuré Box pour Amazon Kendra, consultezPrérequis.

Console

Pour vous connecter Amazon Kendra à Box

  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 Box connector, puis Add connector. Si vous utilisez la version 2 (le cas échéant), choisissez le connecteur Box 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 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. Box Enterprise ID —Entrez votre Box Enterprise ID. Par exemple, 801234567.

    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 Box. Si vous choisissez de créer un nouveau secret, une fenêtre AWS Secrets Manager secrète s'ouvre.

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

      2. Pour l'ID client, le secret client, l'ID de clé publique, l'ID de clé privée et le mot de passe, entrez les valeurs de la clé publique/privée que vous avez configurée dans Box.

      3. Ajoutez et enregistrez 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 contextuel utilisateur des résultats de recherche. 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.

    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. ID des dossiers Box : entrez certains identifiants de dossiers Box que vous souhaitez explorer, sinon le contenu de tous les dossiers sera analysé.

    2. Fichiers Box : choisissez d'explorer les liens Web, les commentaires et les tâches.

    3. Pour une configuration supplémentaire : ajoutez des modèles d'expressions régulières pour inclure ou exclure certains contenus.

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

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

    6. 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 que la source de données aura été ajoutée avec succès.

API

Pour vous connecter Amazon Kendra à Box

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

Box Enterprise ID : saisissez votre Box Enterprise ID. Vous trouverez l'identifiant d'entreprise dans les paramètres de la Box Developer Console ou lorsque vous configurez une application dans Box.

  • 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 Box. Le secret est stocké dans une structure JSON avec les clés suivantes :

    {
    "clientID": "client-id",
    "clientSecret": "client-secret",
    "publicKeyID": "public-key-id",
    "privateKey": "private-key",
    "passphrase": "pass-phrase"
}

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

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

  • Virtual Private Cloud (VPC) —Spécifiez dans le VpcConfiguration cadre de la configuration de la source de données. Reportez-vous Amazon Kendra à la section Configuration pour utiliser un VPC.

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

  • Commentaires, tâches, liens Web : indiquez si vous souhaitez explorer ces types de contenu.

    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.

  • Filtres d'inclusion et d'exclusion : indiquez si vous souhaitez inclure ou exclure certains fichiers et dossiers Box.

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

En savoir plus

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