Quip

Quip est un logiciel de productivité collaboratif qui offre des fonctionnalités de création de documents en temps réel. Vous pouvez l'utiliser Amazon Kendra pour indexer vos dossiers, fichiers, commentaires de fichiers, forums de discussion et pièces jointes Quip.

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

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

Fonctionnalités prises en charge

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

• Mappages de champs

• Contrôle d'accès des utilisateurs

• Filtres d'inclusion/exclusion

• Cloud privé virtuel (VPC)

Prérequis

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

Dans Quip, assurez-vous d'avoir :

• Un compte Quip doté d'autorisations administratives.

• Vous avez créé des identifiants d'authentification Quip qui incluent un jeton d'accès personnel. Le jeton est utilisé comme identifiant d'authentification stocké dans un AWS Secrets Manager secret. Consultez la documentation de Quip sur l'authentification 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).

• Vous avez copié le domaine de votre site Quip. Par exemple, https://quip-company.quipdomain.com/browse où quipdomain est le domaine.

• Il est vérifié que chaque document est unique dans Quip 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 Quip 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 Quip à 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 Quip, vous devez fournir les détails nécessaires de votre source de données Quip afin de Amazon Kendra pouvoir accéder à vos données. Si vous n'avez pas encore configuré Quip pour Amazon Kendra, consultezPrérequis.

Console

Pour vous connecter Amazon Kendra à Quip

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 Quip, puis sélectionnez Ajouter un connecteur. Si vous utilisez la version 2 (le cas échéant), choisissez le connecteur Quip 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. Nom de domaine Quip —Entrez le nom de domaine Quip que vous avez copié depuis votre compte Quip.

   2. AWS Secrets Manager secret —Choisissez un secret existant ou créez-en un nouveau Secrets Manager pour stocker vos informations d'authentification Quip. 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 -Quip » est automatiquement ajouté à votre nom secret.

         2. Jeton Quip —Entrez l'accès personnel Quip configuré pour Quip.

      2. Ajoutez et enregistrez 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. Ajouter les identifiants de dossiers Quip à analyser : les identifiants de dossiers Quip que vous souhaitez explorer.

      Note

      Pour explorer un dossier racine, y compris tous les sous-dossiers et documents qu'il contient, ajoutez l'ID du dossier racine. Pour explorer des sous-dossiers spécifiques, ajoutez les identifiants de sous-dossiers spécifiques.

   2. Configuration supplémentaire (types de contenu) : entrez les types de contenu que vous souhaitez analyser.

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

   4. Dans Synchroniser le calendrier d'exécution, 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. Sélectionnez parmi les champs de source de données par défaut générés que vous souhaitez Amazon Kendra mapper à l'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 à Quip

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

• Domaine du site Quip : par exemple, https://quip-company.quipdomain.com/browse où quipdomain est le domaine.

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

  {
      "accessToken": "token"
  }

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

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.

• Filtres d'inclusion et d'exclusion : spécifiez si vous souhaitez inclure ou exclure certains fichiers.

  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.

• Dossiers : spécifiez les dossiers et sous-dossiers Quip que vous souhaitez indexer

  Note

  Pour explorer un dossier racine, y compris tous les sous-dossiers et documents qu'il contient, entrez l'ID du dossier racine. Pour explorer des sous-dossiers spécifiques, ajoutez les identifiants de sous-dossiers spécifiques.

• Pièces jointes, salons de discussion, commentaires sur les fichiers : choisissez d'inclure ou non l'exploration des pièces jointes, du contenu des salons de discussion et des commentaires sur les fichiers.

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

En savoir plus

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

• Recherchez des connaissances dans des documents Quip grâce à la recherche intelligente à l'aide du connecteur Quip pour Amazon Kendra