Quip - Amazon Kendra

Quip

注意

Quip 连接器将继续为现有客户提供完整支持,直至 2026 年 5 月 31 日。该连接器虽已不再面向新用户开放,但现有用户可继续无中断使用。我们正在持续优化我们的连接器产品组合,以提供更具可扩展性和可定制性的解决方案。对于未来集成,我们建议探索 Amazon Kendra 自定义连接器框架[1],该框架旨在支持更广泛的企业使用案例,并且具备更大的灵活性。

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

您可以使用 Amazon Kendra 控制台QuipConfiguration API 将 Amazon Kendra 连接到您的 Quip 数据来源。

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

支持的功能

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

  • 字段映射

  • 用户访问控制

  • 包含/排除筛选条件

  • 虚拟私有云(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,请记下 IAM 角色的 ARN。

    注意

    如果您更改了身份验证类型和证书,则必须更新您的 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 才能访问您的数据。如果您还没有为 Amazon Kendra 配置 Quip,请参阅先决条件

Console

将 Amazon Kendra 连接到 Quip

  1. 登录 AWS 管理控制台并打开 Amazon Kendra 控制台

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

    注意

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

  3. 入门页面上,选择添加数据来源

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

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

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

    2. (可选)描述:输入数据来源的描述信息。

    3. 默认语言中,选择用于筛选文档以编制索引的语言。除非另行指定,否则语言默认为英语。在文档元数据中指定的语言会覆盖所选语言。

    4. 标签中,对于添加新标签 – 添加用于搜索和筛选资源或跟踪 AWS 成本的标签。

    5. 选择下一步

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

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

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

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

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

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

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

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

    4. IAM 角色 - 选择现有 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 是域名。

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

    { "accessToken": "token" }
  • IAM 角色 - 指定 RoleArn,以便调用 CreateDataSource 来向 IAM 角色提供访问您的 Secrets Manager 密钥的权限,以及为 Quip 连接器和 Amazon Kendra 调用所需的公共 API 的权限。有关更多信息,请参阅 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 数据来源集成的更多信息,请参阅: