Microsoft SharePoint 是一个基于网站的协作系统,它使用工作流应用程序、“列表”数据库以及其他 Web 部件和安全功能,帮助业务团队协同工作,由 Microsoft 开发。本笔记本介绍了如何从 SharePoint 文档库加载文档。默认情况下,文档加载器加载
pdf、doc、docx 和 txt 文件。您可以通过提供适当的解析器来加载其他文件类型(详见下文)。
先决条件
- 按照 Microsoft 身份平台的说明注册应用程序。
- 注册完成后,Azure 门户会显示应用注册的“概述”窗格。您将看到应用程序(客户端)ID。此值也称为
client ID,它在 Microsoft 身份平台中唯一标识您的应用程序。 - 在第 1 项中您将遵循的步骤中,可以将重定向 URI 设置为
https://login.microsoftonline.com/common/oauth2/nativeclient - 在第 1 项中您将遵循的步骤中,在“应用程序机密”部分下生成一个新密码 (
client_secret)。 - 请遵循此文档中的说明,将以下
SCOPES(offline_access和Sites.Read.All) 添加到您的应用程序中。 - 要从您的文档库检索文件,您需要其 ID。要获取它,您需要
Tenant Name、Collection ID和Subsite ID的值。 - 要查找您的
Tenant Name,请遵循此文档中的说明。获取此信息后,只需从值中删除.onmicrosoft.com,其余部分即为您的Tenant Name。 - 要获取您的
Collection ID和Subsite ID,您需要您的 SharePointsite-name。您的SharePoint网站 URL 格式为https://<tenant-name>.sharepoint.com/sites/<site-name>。此 URL 的最后一部分是site-name。 - 要获取站点
Collection ID,请在浏览器中访问此 URL:https://<tenant>.sharepoint.com/sites/<site-name>/_api/site/id,并复制Edm.Guid属性的值。 - 要获取
Subsite ID(或 web ID),请使用:https://<tenant>.sharepoint.com/sites/<site-name>/_api/web/id并复制Edm.Guid属性的值。 SharePoint 站点 ID的格式如下:<tenant-name>.sharepoint.com,<Collection ID>,<subsite ID>。您可以保留该值以在下一步中使用。- 访问 Graph Explorer Playground 以获取您的
文档库 ID。第一步是确保您已使用与您的 SharePoint 站点关联的帐户登录。然后您需要向https://graph.microsoft.com/v1.0/sites/<SharePoint 站点 ID>/drive发出请求,响应将返回一个负载,其中包含一个id字段,该字段保存您的文档库 ID。
🧑 从 SharePoint 文档库导入文档的说明
🔑 身份验证
默认情况下,SharePointLoader 期望 CLIENT_ID 和 CLIENT_SECRET 的值分别存储为名为 O365_CLIENT_ID 和 O365_CLIENT_SECRET 的环境变量。您可以通过应用程序根目录下的 .env 文件或在脚本中使用以下命令来传递这些环境变量。
o365_token.txt)存储在 ~/.credentials/ 文件夹中。此令牌以后可用于身份验证,无需前面解释的复制/粘贴步骤。要使用此令牌进行身份验证,您需要在加载器实例化时将 auth_with_token 参数更改为 True。
🗂️ 文档加载器
📑 从文档库目录加载文档
SharePointLoader 可以从文档库中特定文件夹加载文档。例如,您希望加载存储在文档库中 Documents/marketing 文件夹下的所有文档。
Resource not found for the segment,请尝试使用 folder_id 而非文件夹路径,folder_id 可从 Microsoft Graph API 获取
folder_id、folder_path 和 documents_ids,加载器将加载根目录。
recursive=True,您可以简单地加载整个 SharePoint 中的所有文档
📑 从文档 ID 列表加载文档
另一种可能性是为每个您想要加载的文档提供一个object_id 列表。为此,您需要查询 Microsoft Graph API 以查找所有您感兴趣的文档 ID。此链接提供了一个有助于检索文档 ID 的端点列表。 例如,要检索存储在 data/finance/ 文件夹中的所有对象的信息,您需要向以下地址发出请求:https://graph.microsoft.com/v1.0/drives/<document-library-id>/root:/data/finance:/children。一旦您有了感兴趣的 ID 列表,就可以使用以下参数实例化加载器。📑 选择支持的文件类型和首选解析器
默认情况下,SharePointLoader 使用默认解析器(见下文)加载 document_loaders/parsers/registry 中定义的文件类型。
handlers 参数传递给 SharePointLoader 来覆盖此行为。传递一个字典,将文件扩展名(如 "doc"、"pdf" 等)或 MIME 类型(如 "application/pdf"、"text/plain" 等)映射到解析器。请注意,您必须专门使用文件扩展名或 MIME 类型,不能混用。 文件扩展名不需要包含前导点。以编程方式连接这些文档到 Claude、VSCode 等,通过 MCP 获取实时答案。