Quip

Quip 是一款协作生产力软件，可提供实时文档创作功能。您可以使用 Amazon Kendra 索引 Quip 文件夹、文件、文件评论、聊天室和附件。

您可以使用Amazon Kendra 控制台和 QuipConfigurationAPI 连接 Amazon Kendra 到 Quip 数据源。

要对 Amazon Kendra Quip 数据源连接器进行故障排除，请参阅数据来源故障排除。

支持的特征

Amazon Kendra Quip 数据源连接器支持以下功能：

• 字段映射

• 用户访问控制

• 包含/排除筛选条件

• Virtual Private Cloud (VPC)

先决条件

在使用 Amazon Kendra 索引 Quip 数据源之前，请在您的 Quip 和 AWS 帐户中进行这些更改。

在 Quip 中，请确保：

• 拥有一个具有管理权限的 Quip 账户

• 已创建包含个人访问令牌的 Quip 身份验证凭证。该令牌用作存储在 AWS Secrets Manager 密钥中的身份验证凭证。有关更多信息，请参阅有关身份验证的 Quip 文档。

  注意

  我们建议您定期刷新或轮换您的凭证和密码。为了安全起见，请仅提供必要的访问权限级别。我们建议不要跨数据来源以及连接器版本 1.0 和 2.0（如果适用）重复使用凭证和密钥。

• 已复制 Quip 站点域名。例如，https://quip-company.quipdomain.com/browse，其中 quipdomain 是域名。

• 在 Quip 以及计划用于编制同一索引的其他数据来源中，已检查每个文档都是唯一的。您要用于编制索引的每个数据来源在所有数据来源中都不能包含相同的文档。文档 ID 对索引来说是全局性的，并且每个索引都必须是唯一的。

在你的 AWS 账户，请确保你有：

• 已创建 Amazon Kendra 索引，如果使用 API，则记下索引 ID。

• 为您的数据源@@ 创建了一个 IAM 角色，如果使用 API，请记下该角色的 ARN。 IAM

  注意

  如果您更改了身份验证类型和证书，则必须更新您的 IAM 角色才能访问正确的 AWS Secrets Manager 密钥 ID。

• 将您的 Quip 身份验证凭证存储在 AWS Secrets Manager 密钥中，如果使用 API，请记下密钥的 ARN。

  注意

  我们建议您定期刷新或轮换您的凭证和密码。为了安全起见，请仅提供必要的访问权限级别。我们建议不要跨数据来源以及连接器版本 1.0 和 2.0（如果适用）重复使用凭证和密钥。

如果您没有现有的 IAM 角色或密钥，则可以在将 Quip 数据源连接到 Amazon Kendra时使用控制台创建新的 IAM 角色和 Secrets Manager 密钥。如果您使用的是 API，则必须提供现有 IAM 角色和 Secrets Manager 密钥的 ARN 以及索引 ID。

连接说明

要连接 Amazon Kendra 到 Quip 数据源，您必须提供 Quip 数据源的必要详细信息， Amazon Kendra 以便访问您的数据。如果您尚未为 Quip 配置 Amazon Kendra，请参阅先决条件。

Console

连接 Amazon Kendra 到 Quip

1. 登录 AWS Management Console 并打开Amazon Kendra 控制台。

2. 在左侧导航窗格中，选择索引，然后从索引列表中选择要使用的索引。

   注意

   您可以选择在索引设置下配置或编辑您的用户访问控制设置。

3. 在入门页面上，选择添加数据来源。

4. 在添加数据源页面上，选择 Quip 连接器，然后选择添加连接器。如果使用版本 2（如果适用），请选择带有 “V2.0” 标签的 Quip 连接器。

5. 在指定数据来源详细信息页面上输入以下信息：

   1. 在名称和描述中，在数据来源名称中输入您的数据来源的名称。可以包含连字符，但不能包含空格。

   2. （可选）说明 - 为数据来源输入说明。

   3. 使用默认语言-选择一种语言来筛选文档中的索引。除非另行指定，否则语言默认为英语。在文档元数据中指定的语言会覆盖所选语言。

   4. 在标签中，用于添加新标签-包括可选标签以搜索和筛选您的资源或跟踪您的 AWS 成本。

   5. 选择下一步。

6. 在定义访问权限和安全性页面上，请输入以下信息：

   1. Quip 域名 - 输入您从 Quip 账户中复制的域名。

   2. AWS Secrets Manager s@@ ecret —选择现有密钥或创建新 Secrets Manager 密钥来存储您的 Quip 身份验证凭据。如果您选择创建新密钥，则会打开 AWS Secrets Manager 密钥窗口。

      1. 在创建 AWS Secrets Manager 密钥窗口中输入以下信息：

         1. 密钥名称 - 密钥的名称。前缀 “AmazonKendra-Quip-” 会自动添加到您的密钥名称中。

         2. Quip 令牌-输入配置的 Quip 个人访问权限 Quip。

      2. 添加并保存您的密钥。

   3. 虚拟私有云（VPC）- 您可以选择使用 VPC。如果是这样，则必须添加子网和 VPC 安全组。

   4. IAM ro le —选择现有 IAM 角色或创建新 IAM 角色来访问您的存储库凭据和索引内容。

      注意

      IAM 用于索引的角色不能用于数据源。如果您不确定是否将现有角色用于编制索引或常见问题解答，为了避免出错，请选择创建新角色。

   5. 选择下一步。

7. 在配置同步设置页面上，请输入以下信息：

   1. 添加要爬取的 Quip 文件夹 ID - 要爬取的 Quip 文件夹 ID。

      注意

      要对根文件夹（包括其中的所有子文件夹和文档）进行爬网，请添加根文件夹 ID。要搜索特定的子文件夹，请添加特定的子文件夹 ID。

   2. 其他配置（内容类型） - 输入要爬取的内容类型。

   3. 正则表达式模式 - 包含或排除某些文件的正则表达式模式。最多可以添加 100 个模式。

   4. 在 “同步” 运行计划中，“频率”-选择同步数据源内容和更新索引的频率

   5. 选择下一步。

8. 在设置字段映射页面上，请输入以下信息：

   1. 从生成的默认数据源字段中选择要映射到 Amazon Kendra 索引的字段。

   2. 添加字段 - 添加自定义数据来源字段以创建要映射到的索引字段名称和字段数据类型。

   3. 选择下一步。

9. 在查看和创建页面上，请检查输入的信息是否正确，然后选择添加数据来源。您也可以选择在此页面上编辑信息。成功添加数据来源后，您的数据来源将显示在数据来源页面上。

API

连接 Amazon Kendra 到 Quip

您必须使用 QuipConfiguration API 指定以下内容：

• Quip 网站域名 - 例如，https://quip-company.quipdomain.com/browse，其中 quipdomain 是域名。

• 亚马逊秘密资源名称 (ARN)-提供包含您的 Quip 账户身份验证凭证的 Secrets Manager 密钥的亚马逊资源名称 (ARN)。密钥必须使用具有以下键的 JSON 结构存储：

  {
      "accessToken": "token"
  }

• IAM ro le —指定RoleArn何时调用CreateDataSource以向 IAM 角色提供访问您的 Secrets Manager 密钥和调用 Quip 连接器所需的公共 API 的权限，以及。 Amazon Kendra有关更多信息，请参阅 Quip 数据来源的IAM 角色。

您还可以添加以下可选功能：

• 虚拟私有云（VPC）- 在数据来源配置中指定 VpcConfiguration。请参阅配置 Amazon Kendra 以使用 VPC。

• 包含和排除筛选条件 - 指定是包含还是排除文件。

  注意

  大多数数据来源使用正则表达式模式，即称为筛选条件的包含或排除模式。如果您指定包含筛选条件，则只会为与包含筛选条件匹配的内容编制索引。不会为任何与包含筛选条件不匹配的文档编制索引。如果您指定包含和排除筛选条件，则不会为与排除筛选条件匹配的文档编制索引，即使它们与包含筛选条件相匹配。

• 文件夹-指定要索引的 Quip 文件夹和子文件夹

  注意

  要抓取根文件夹，包括其中的所有子文件夹和文档，请输入根文件夹 ID。要搜索特定的子文件夹，请添加特定的子文件夹 ID。

• 附件、聊天室、文件评论-选择是否包括抓取附件、聊天室内容和文件评论。

• 用户上下文筛选和访问控制-如果您的文档有 ACL，则会Amazon Kendra 搜索文档的访问控制列表 (ACL)。ACL 信息用于根据用户或用户组对文档的访问权限来筛选搜索结果。有关更多信息，请参阅用户上下文筛选。

• 字段映射 - 选择将 Quip 数据来源字段映射到 Amazon Kendra 索引字段。有关更多信息，请参阅映射数据来源字段。

  注意

  要搜索您的文档，必须输入文档正文字段或文档正文等效字段。 Amazon Kendra 您必须将数据源中的文档正文字段名称映射到索引字段名称_document_body。其他所有字段均为可选字段。

了解更多信息

要了解有关 Amazon Kendra 与 Quip 数据源集成的更多信息，请参阅：

• 使用 Quip 连接器通过智能搜索在 Quip 文档中搜索知识 Amazon Kendra