View a markdown version of this page

连接 SharePoint 数据源 - Amazon Bedrock

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

连接 SharePoint 数据源

设置身份验证并将凭据存储在 AWS Secrets Manager 密钥中后,在知识库中创建 SharePoint 数据源。本页介绍如何使用 AWS 管理控制台 或 API 创建数据源,然后介绍您可以配置的连接器参数。

注意

首先完成身份验证设置。请参阅User-managed 设置 (3LO)(最简单)、设置 Microsoft Entra ID App-Only 身份验证用于 SharePoint(推荐用于文档级访问控制)或。为 OAuth 2.0 身份验证设置 SharePoint对于用户管理的设置 (3LO),您通过控制台登录,Amazon Bedrock 会为您创建密钥(使用系统生成的 ARN);您不提供密钥或租户 ID。对于其他方法,你需要秘密 ARN、租户 ID 以及(用于微软 Entra ID App-Only 身份验证)证书的 Amazon S3 位置。

创建数据源

Console
SharePoint 连接到您的托管知识库
  1. 在 “数据源” 下,为您的数据源提供一个名称。

  2. SharePoint从数据源下拉列表中选择。

  3. 在 “来源” 下,输入您的网站网址。每个 URL 必须以站点https://、团队网站或个人网站开头并指向该站点(例如https://contoso.sharepoint.com/sites/engineering)。最多可以添加 100 个 URL。

  4. 在 “身份验证” 下,选择User-managed 设置 (3LO) 微软 Entra ID App-Only OAuth 2.0 身份验证。对于用户管理的设置 (3LO),可以选择输入密钥名称前缀。然后选择 “登录” 以登录 SharePoint 并授权连接。您不提供机密或租户 ID。Amazon Bedrock 使用系统生成的 ARN 创建了一个密钥来存储代币。有关更多信息,请参阅 User-managed 设置 (3LO)

  5. 选择或创建 AWS Secrets Manager 密钥来存储您的证书。

  6. 输入您的租户 ID

  7. 如果您选择了微软 Entra ID App-Only 身份验证,请提供证书路径,即.p12证书文件的 Amazon S3 路径。

  8. (可选)要启用文档级访问控制,请选择使用 ACL 控制文档访问权限。此选项仅在 Microsoft Entra ID App-Only 身份验证时可用,创建后无法更改。有关更多信息,请参阅 Document-level 访问控制

  9. (可选)扩展同步范围以配置要抓取的内容(文件、页面)。

  10. (可选)扩展基于日期的实体同步以指定日期过滤器。

  11. (可选)展开项目路径模式以添加特定路径来筛选要搜索的项目。

API

要创建 SharePoint 数据源,请使用适用于 Amazon Bedrock 构建时终端节点的代理发送CreateDataSource请求。以下 AWS Command Line Interface 示例创建了一个使用微软 Entra ID App-Only 身份验证的数据源。要启用文档级访问控制,请将设置为aclEnabledtrue有关每个字段的描述,请参阅随后的连接器参数参考。

aws bedrock-agent create-data-source \ --name "SharePoint-connector" \ --knowledge-base-id "your-knowledge-base-id" \ --data-source-configuration file://sharepoint-managed-connector.json

sharepoint-managed-connector.json文件包含以下内容:

{ "type": "MANAGED_KNOWLEDGE_BASE_CONNECTOR", "managedKnowledgeBaseConnectorConfiguration": { "connectorParameters": { "type": "SHAREPOINT", "version": "1", "aclEnabled": false, "connectionConfiguration": { "secretArn": "arn:aws:secretsmanager:us-west-2:123456789012:secret:bedrock-sharepoint-creds", "tenantId": "12345678-1234-1234-1234-123456789012", "authType": "ENTRA_ID_APP_ONLY", "certificateS3Path": { "s3BucketName": "your-certificate-bucket", "s3KeyName": "certs/certificate.p12" } }, "dataEntityConfiguration": { "crawlFiles": true, "crawlPages": true, "siteUrls": [ "https://contoso.sharepoint.com/sites/engineering" ] } } } }

对于OAUTH2_APP数据源,设置为authTypeOAUTH2_APP并省略certificateS3Path。对于用户管理的设置 (3LO),设置authTypeMANAGED_OAUTH2并省略。certificateS3Path您无法通过 API 创建 3LO 密钥:首先通过控制台登录以创建密钥,然后设置secretArn为该密钥的 ARN。有关更多信息,请参阅 User-managed 设置 (3LO)

对于托管知识库,CreateDataSource是异步的:操作完成后,数据源状态从过渡CREATINGAVAILABLE

连接器参数

数据源配置使用以下连接器参数。要连接到 SharePoint,请在中指定SHAREPOINT为连接器类型connectorParameters。有关换行字段connectorParameters(例如deletionProtectionConfigurationmediaExtractionConfiguration),请参阅连接数据来源

connectionConfiguration
字段 必填 描述
secretArn 包含您的 SharePoint 证书的 AWS Secrets Manager 密钥的 ARN。
tenantId 微软 Entra (Azure AD) 租户 ID。
authType 身份验证类型:MANAGED_OAUTH2(用户管理的设置,3LO)、ENTRA_ID_APP_ONLY(推荐)或。OAUTH2_APP请参阅身份验证方法
certificateS3Path 有条件 即使禁用 ACL,也需要ENTRA_ID_APP_ONLY进行身份验证。包含s3BucketName和,s3KeyName用于 Amazon S3 中的证书文件。不与... 一起使用OAUTH2_APP
数据 EntityConfiguration
字段 必填 描述
siteUrls 要抓取的 SharePoint 网站网址列表。每个 URL 都是抓取入点,必须以站点、团队网站或个人网站开头https://并指向该站点、团队网站或个人网站 /sites//teams/,路径必须以网站名称开头或/personal/后跟网站名称(例如,https://contoso.sharepoint.com/sites/engineering)。支持标准*.sharepoint.com域和自定义(虚拟)域。在每个站点内,连接器会抓取文件和页面(参见crawlFilescrawlPages);要定位特定项目,请使用inclusionItemPaths
crawlFiles 是否抓取文件。默认值为 true
crawlPages 是否抓取页面。默认值为 true
过滤器配置(可选)
字段 必填 说明
modifiedDateBefore 仅包括在此日期之前修改的内容 (ISO 8601)。
modifiedDateAfter 仅包括在此日期之后修改的内容 (ISO 8601)。
inclusionItemPaths 要包含的特定项目路径。当您提供时inclusionItemPaths,连接器会抓取这些项目并且不进行验证siteUrls
ACLE已启用(可选)
字段 必填 说明
aclEnabled 设置为true以启用文档级访问控制。需要ENTRA_ID_APP_ONLY身份验证。创建数据源后,您无法更改此设置。有关更多信息,请参阅 Document-level 访问控制

更改身份验证方法

您可以使用UpdateDataSource操作或,使用新的authType和凭据更新数据源,从而更改数据源的身份验证方法(例如,从 OAuth 2.0 更改为 Microsoft Entra ID App-Only)。 AWS 管理控制台创建数据源时,文档级访问控制设置是固定的,因此要添加或删除 ACL,必须创建新的数据源。

后续步骤

创建数据源后,将其同步以将内容摄取到您的知识库中。有关更多信息,请参阅 同步数据来源。要按用户权限筛选查询结果,请参阅Document-level 访问控制