Dropbox - Amazon Kendra

本文属于机器翻译版本。若本译文内容与英语原文存在差异,则一律以英文原文为准。

Dropbox

Dropbox 是一项文件托管服务,提供云存储、文档整理和文档模板服务。如果您是 Dropbox 用户,则可以使用Amazon Kendra索引您的 Dropbox 文件、Dropbox Paper、Dropbox Paper 模板和存储的网页快捷方式。您还可以配置Amazon Kendra为索引特定的 Dropbox 文件、Dropbox Paper、Dropbox Paper 模板和存储的网页快捷方式。

Amazon Kendra同时支持 Dropbox Business 版 Dropbox 和

您可以使用Amazon Kendra控制台TemplateConfigurationAPI Amazon Kendra 连接到您的 Dropbox 数据源。

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

支持的功能

Amazon KendraDropbox 数据源连接器支持以下功能:

  • 字段映射

  • 用户访问控制

  • 包含/排除筛选条件

  • 完整和增量内容同步

  • 虚拟私有云(VPC)

先决条件

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

在 Dropbox 中,请确保:

  • 已创建 Dropbox Advanced 账户并设置了管理员用户。

  • 已配置一个具有唯一应用程序名称的 Dropbox 应用程序,并激活了作用域访问权限。请参阅有关创建应用程序的 Dropbox 文档

  • 在 Dropbox 控制台上激活了 Dropbox 的完整权限,并添加了以下权限:

    • files.content.read

    • files.metadata.read

    • sharing.read

    • file_requests.read

    • groups.read

    • team_info.read

    • team_data.content.read

  • 已记下您的 Dropbox 应用程序键、Dropbox 应用程序密钥和适用于基本身份验证凭证的 Dropbox 访问令牌

    注意

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

  • 已为您的 Dropbox 应用程序配置并复制临时的 Oauth 2.0 访问令牌。此令牌是临时性的,将在 4 小时后过期。请参阅有关 OAuth 身份验证的 Dropbox 文档

    注意

    建议您创建永不过期的 Dropbox 刷新访问令牌,而不是依赖在 4 小时后过期的一次性访问令牌。刷新访问令牌是永久性的,永不过期,因此您将来可以继续同步数据来源。

  • 推荐:已配置永不过期的 Dropbox 永久刷新令牌,Amazon Kendra以便在不中断的情况下继续同步您的数据源。请参阅有关刷新令牌的 Dropbox 文档

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

在你的AWS 账户,请确保你有:

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

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

    注意

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

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

    注意

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

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

连接说明

要Amazon Kendra连接到您的 Dropbox 数据源,您必须提供 Dropbox 数据源的必要详细信息,这样Amazon Kendra他们才能访问您的数据。如果您尚未配置 DropboxAmazon Kendra,请参阅先决条件

Console

连接到 Drop Amazon Kendra box

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

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

    注意

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

  3. 开始使用页面上,选择添加数据来源

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

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

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

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

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

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

    5. 选择下一步

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

    1. 授权 - 如果您有访问控制列表(ACL)并想将其用于访问控制,请选择是开启还是关闭文档的 ACL 信息。ACL 用于指定用户和组可以访问哪些文档。ACL 信息用于根据用户或其所在组对文档的访问权限来筛选搜索结果。有关更多信息,请参阅用户上下文筛选

    2. 身份验证令牌的类型 - 选择永久令牌(推荐)或临时访问令牌。

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

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

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

        2. 对于应用程序键应用程序密钥和令牌信息(永久令牌或临时令牌)- 输入您在 Dropbox 中配置的身份验证凭证值。

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

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

    5. 身份爬网程序 – 指定是否激活 Amazon Kendra 的身份爬网程序。身份爬网程序使用文档的访问控制列表(ACL)信息,来根据用户或用户组对文档的访问权限筛选搜索结果。如果您的文档有 ACL 并选择使用 ACL,则也可以选择开启身份爬网程序来配置搜索结果Amazon Kendra的用户上下文筛选。否则,如果关闭身份爬网程序,则可以公开搜索所有文档。如果您想对文档使用访问控制并且身份搜寻器已关闭,则可以使用 PutPrincipalMappingAPI 上传用户和群组访问信息以进行用户上下文筛选。

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

      注意

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

    7. 选择下一步

  7. 配置同步设置页面上,请输入以下信息:

    1. 对于选择实体或内容类型 - 选择要爬取的 Dropbox 实体或内容类型。

    2. 其他配置中,对于正则表达式模式 - 添加正则表达式模式以包含或排除某些文件。

    3. 同步模式 – 选择在数据来源内容发生变化时更新索引的方式。首次与同步数据源时,Amazon Kendra默认情况下会对所有内容进行抓取和索引。如果首次同步失败,即使您没有选择“完整同步”作为同步模式,也必须执行一次完整的数据同步。

      • 完整同步:每次数据来源与索引同步时,重新为所有内容编制索引,并替换已有内容。

      • 新增、修改的同步:每次数据来源与索引同步时,仅为新增和修改的内容编制索引。Amazon Kendra 可以利用数据来源自身的内容变更跟踪机制,仅为自上次同步以来发生变化的内容编制索引。

      • 新增、已修改、已删除的同步:每次数据源与索引同步时,仅索引新内容、修改内容和已删除内容。 Amazon Kendra可以使用数据源的机制来跟踪内容更改并索引自上次同步以来更改的内容。

    4. 同步运行计划频率中 – 选择同步数据来源内容并更新索引的频率。

    5. 选择下一步

  8. 设置字段映射页面上,请输入以下信息:

    1. 文件Dropbox Pap er 和 Dropbox Paper 模板-从Amazon Kendra生成的默认数据源字段中选择要映射到索引的默认数据源字段。

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

    3. 选择下一步

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

API

连接到 Drop Amazon Kendra box

您必须使用 TemplateConfiguration API 指定数据来源架构的 JSON。您必须提供以下信息:

  • 数据来源 – 当使用 TemplateConfiguration JSON 架构时,将数据来源类型指定为 DROPBOX。当调用 CreateDataSource API 时,还要将数据来源指定为 TEMPLATE

  • 同步模式-指定数据源内容发生变化时Amazon Kendra应如何更新索引。首次将数据来源与 Amazon Kendra 同步时,默认情况下会爬取所有内容并编制索引。如果首次同步失败,即使您没有选择“完整同步”作为同步模式,也必须执行一次完整的数据同步。您可以选择:

    • FORCED_FULL_CRAWL,每次数据来源与索引同步时,重新为所有内容编制索引,并替换已有内容。

    • FULL_CRAWL,每次数据来源与索引同步时,仅为新增、修改和删除的内容编制索引。Amazon Kendra 可以利用数据来源自身的内容变更跟踪机制,仅为自上次同步以来发生变化的内容编制索引。

    • CHANGE_LOG,每次数据来源与索引同步时,仅为新增和修改的内容编制索引。Amazon Kendra 可以利用数据来源自身的内容变更跟踪机制,仅为自上次同步以来发生变化的内容编制索引。

  • 访问令牌类型 - 指定要对存储身份验证凭证的 AWS Secrets Manager 密钥使用永久访问令牌还是临时访问令牌。

    注意

    建议您创建在 Dropbox 中永不过期的刷新访问令牌,而不是依赖在 4 小时后过期的一次性访问令牌。您可以在 Dropbox 开发者控制台中创建应用程序和刷新访问令牌,并在密钥中提供访问令牌。

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

    { "appKey": "Dropbox app key", "appSecret": "Dropbox app secret", "accesstoken": "temporary access token or refresh access token" }
  • 身份爬网程序 - 指定是否激活 Amazon Kendra 的身份爬网程序。身份爬网程序使用文档的访问控制列表(ACL)信息,来根据用户或用户组对文档的访问权限筛选搜索结果。如果您的文档有 ACL 并选择使用 ACL,则也可以选择开启身份爬网程序来配置搜索结果Amazon Kendra的用户上下文筛选。否则,如果关闭身份爬网程序,则可以公开搜索所有文档。如果您想对文档使用访问控制并且身份搜寻器已关闭,则可以使用 PutPrincipalMappingAPI 上传用户和群组访问信息以进行用户上下文筛选。

  • IAM角色 —指定RoleArn何时致电CreateDataSource为IAM角色提供访问您的Secrets Manager密钥的权限,以及致电 APIs 所需的公众访问 Dropbox 连接器和Amazon Kendra。有关更多信息,请参阅 Dropbox 数据来源的 IAM 角色

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

  • 虚拟私有云(VPC)- 指定 VpcConfiguration,以便调用 CreateDataSource。有关更多信息,请参阅 配置Amazon Kendra为使用 Amazon VPC

  • 文档/内容类型 – 指定是否爬取 Dropbox 中的文件、Dropbox Paper 文档、Dropbox Paper 模板以及存储在 Dropbox 中的网页快捷方式。

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

    注意

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

  • 访问控制列表(ACL)- 如果您有 ACL 并想将其用于访问控制,请选择是否爬取文档的 ACL 信息。ACL 用于指定用户和组可以访问哪些文档。ACL 信息用于根据用户或其所在组对文档的访问权限来筛选搜索结果。有关更多信息,请参阅用户上下文筛选

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

    注意

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

有关要配置的其他重要 JSON 键的列表,请参阅 Dropbox 模板架构

了解详情

要了解有关将 Amazon Kendra 与 Dropbox 数据来源集成的更多信息,请参阅:

注意

  • 启用访问控制列表 (ACLs) 后,由于 Dropbox API 的限制,“仅同步新内容或修改过的内容” 选项不可用。我们建议改用 “完全同步” 或 “新建、修改或删除的内容同步” 模式,或者 ACLs 如果您需要使用此同步模式,则将其禁用。