Microsoft SharePoint

Microsoft SharePoint 是一个基于网站的协作系统，使用工作流应用程序、“列表”数据库以及其他网页组件和安全功能，旨在帮助商业团队协作，由微软开发。

本笔记本涵盖如何从 SharePoint 文档库 加载文档。目前，仅支持 docx、doc 和 pdf 文件。

前提条件

1. 根据 Microsoft 身份平台 的说明注册一个应用程序。
2. 注册完成后，Azure 门户会显示应用注册的概述面板。您可以看到应用程序（客户端）ID。此值也称为 client ID，它唯一标识您在 Microsoft 身份平台中的应用程序。
3. 在您将要遵循的 第 1 项 步骤中，您可以将重定向 URI 设置为 https://login.microsoftonline.com/common/oauth2/nativeclient
4. 在您将要遵循的 第 1 项 步骤中，在应用程序机密部分生成一个新密码（client_secret）。
5. 按照此 文档 中的说明，将以下 SCOPES（offline_access 和 Sites.Read.All）添加到您的应用程序。
6. 要从您的 文档库 中检索文件，您需要其 ID。要获取它，您需要 Tenant Name、Collection ID 和 Subsite ID 的值。
7. 要找到您的 Tenant Name，请按照此 文档 中的说明进行操作。获取后，只需从值中删除 .onmicrosoft.com，其余部分即为您的 Tenant Name。
8. 要获取您的 Collection ID 和 Subsite ID，您需要您的 SharePoint site-name。您的 SharePoint 站点 URL 具有以下格式 https://<tenant-name>.sharepoint.com/sites/<site-name>。此 URL 的最后部分即为 site-name。
9. 要获取站点 Collection ID，在浏览器中访问此 URL：https://<tenant>.sharepoint.com/sites/<site-name>/_api/site/id 并复制 Edm.Guid 属性的值。
10. 要获取 Subsite ID（或网页 ID），请使用：https://<tenant>.sharepoint.com/sites/<site-name>/_api/web/id 并复制 Edm.Guid 属性的值。
11. SharePoint 站点 ID 的格式如下：<tenant-name>.sharepoint.com,<Collection ID>,<subsite ID>。您可以保留该值以供下一步使用。
12. 访问 Graph Explorer Playground 以获取您的 Document Library ID。第一步是确保您使用与您的 SharePoint 站点关联的帐户登录。然后您需要请求 https://graph.microsoft.com/v1.0/sites/<SharePoint site ID>/drive，响应将返回一个有效负载，其中包含 id 字段，该字段保存您的 Document Library ID。

🧑 从 SharePoint 文档库导入文档的说明

🔑 认证

默认情况下，SharePointLoader期望CLIENT_ID和CLIENT_SECRET的值必须分别存储为名为O365_CLIENT_ID和O365_CLIENT_SECRET的环境变量。您可以通过在应用程序根目录下的.env文件中传递这些环境变量，或者在脚本中使用以下命令。

os.environ['O365_CLIENT_ID'] = "YOUR CLIENT ID"
os.environ['O365_CLIENT_SECRET'] = "YOUR CLIENT SECRET"

此加载器使用一种称为代表用户的认证方式。这是一种需要用户同意的两步认证。当您实例化加载器时，它将打印出一个用户必须访问的URL，以便对应用程序所需权限给予同意。用户必须访问此URL并对应用程序给予同意。然后，用户必须复制生成页面的URL并粘贴回控制台。如果登录尝试成功，该方法将返回True。

from langchain_community.document_loaders.sharepoint import SharePointLoader

loader = SharePointLoader(document_library_id="YOUR DOCUMENT LIBRARY ID")

完成认证后，加载器将在~/.credentials/文件夹中存储一个令牌(o365_token.txt)。该令牌可以在后续认证中使用，而无需重复之前的复制/粘贴步骤。要使用此令牌进行认证，您需要在加载器的实例化中将auth_with_token参数更改为True。

from langchain_community.document_loaders.sharepoint import SharePointLoader

loader = SharePointLoader(document_library_id="YOUR DOCUMENT LIBRARY ID", auth_with_token=True)

🗂️ 文档加载器

📑 从文档库目录加载文档

SharePointLoader 可以从您文档库中的特定文件夹加载文档。例如，您想加载存储在 Documents/marketing 文件夹中的所有文档。

from langchain_community.document_loaders.sharepoint import SharePointLoader

loader = SharePointLoader(document_library_id="YOUR DOCUMENT LIBRARY ID", folder_path="Documents/marketing", auth_with_token=True)
documents = loader.load()

如果您收到错误 Resource not found for the segment，请尝试使用 folder_id 而不是文件夹路径，该 ID 可以从 Microsoft Graph API 获取。

loader = SharePointLoader(document_library_id="YOUR DOCUMENT LIBRARY ID", auth_with_token=True
                          folder_id="<folder-id>")
documents = loader.load()

如果您希望从根目录加载文档，可以省略 folder_id、folder_path 和 documents_ids，加载器将加载根目录。

# 从根目录加载文档
loader = SharePointLoader(document_library_id="YOUR DOCUMENT LIBRARY ID", auth_with_token=True)
documents = loader.load()

结合 recursive=True，您可以简单地从整个 SharePoint 加载所有文档：

# 从根目录加载文档
loader = SharePointLoader(document_library_id="YOUR DOCUMENT LIBRARY ID",
                          recursive=True,
                          auth_with_token=True)
documents = loader.load()

📑 从文档 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 列表，您可以使用以下参数实例化加载器。

from langchain_community.document_loaders.sharepoint import SharePointLoader

loader = SharePointLoader(document_library_id="YOUR DOCUMENT LIBRARY ID", object_ids=["ID_1", "ID_2"], auth_with_token=True)
documents = loader.load()

相关

• 文档加载器 概念指南
• 文档加载器 操作指南