Microsoft SharePoint 集成

Microsoft SharePoint 是一个基于网站的协作系统，它使用工作流应用程序、“列表”数据库以及其他 Web 部件和安全功能，使业务团队能够协同工作，由 Microsoft 开发。

本笔记本介绍如何从 SharePoint 文档库加载文档。默认情况下，文档加载器会加载 pdf、doc、docx 和 txt 文件。您可以通过提供适当的解析器来加载其他文件类型（详见下文）。

先决条件

按照 Microsoft 身份平台的说明注册一个应用程序。
注册完成后，Azure 门户会显示应用程序注册的“概述”窗格。您会看到应用程序（客户端）ID。这也称为 客户端 ID，此值在 Microsoft 身份平台中唯一标识您的应用程序。
在您将遵循的 第 1 项 步骤中，可以将重定向 URI 设置为 https://login.microsoftonline.com/common/oauth2/nativeclient。
在您将遵循的 第 1 项 步骤中，在“应用程序机密”部分下生成一个新的密码（client_secret）。
按照此文档中的说明，为您的应用程序添加以下 SCOPES（offline_access 和 Sites.Read.All）。
要从您的 文档库 检索文件，您需要其 ID。要获取它，您需要 租户名称、集合 ID 和 子网站 ID 的值。
要查找您的 租户名称，请按照此文档中的说明操作。获得该值后，只需从值中删除 .onmicrosoft.com，其余部分即为您的 租户名称。
要获取您的 集合 ID 和 子网站 ID，您需要您的 SharePoint 站点名称。您的 SharePoint 站点 URL 格式如下：https://<tenant-name>.sharepoint.com/sites/<site-name>。此 URL 的最后一部分是 站点名称。
要获取站点 集合 ID，请在浏览器中访问此 URL：https://<tenant>.sharepoint.com/sites/<site-name>/_api/site/id 并复制 Edm.Guid 属性的值。
要获取 子网站 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>。您可以保存此值以在下一步中使用。
访问图形资源管理器测试平台以获取您的 文档库 ID。第一步是确保您使用与 SharePoint 站点关联的帐户登录。然后，您需要向 https://graph.microsoft.com/v1.0/sites/<SharePoint site ID>/drive 发出请求，响应将返回一个包含 id 字段的有效负载，该字段保存您的 文档库 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 并同意该应用程序。接着，用户必须复制生成的页面 URL 并将其粘贴回控制台。如果登录尝试成功，该方法将返回 True。

from langchain_community.document_loaders.sharepoint import SharePointLoader

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

身份验证完成后，加载器会将令牌（o365_token.txt）存储在 ~/.credentials/ 文件夹中。此令牌可用于后续身份验证，无需执行前面解释的复制/粘贴步骤。要使用此令牌进行身份验证，您需要在实例化加载器时将 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()

📑 选择支持的文件类型和首选解析器

默认情况下，SharePointLoader 使用默认解析器（见下文）加载 document_loaders/parsers/registry 中定义的文件类型。

def _get_default_parser() -> BaseBlobParser:
    """获取基于默认 MIME 类型的解析器。"""
    return MimeTypeBasedParser(
        handlers={
            "application/pdf": PyMuPDFParser(),
            "text/plain": TextParser(),
            "application/msword": MsWordParser(),
            "application/vnd.openxmlformats-officedocument.wordprocessingml.document": (
                MsWordParser()
            ),
        },
        fallback_parser=None,
    )

您可以通过向 SharePointLoader 传递 handlers 参数来覆盖此行为。传递一个字典，将文件扩展名（如 "doc"、"pdf" 等）或 MIME 类型（如 "application/pdf"、"text/plain" 等）映射到解析器。请注意，您必须仅使用文件扩展名或 MIME 类型，不能混合使用。文件扩展名不要包含前导点。

# 使用文件扩展名：
handlers = {
    "doc": MsWordParser(),
    "pdf": PDFMinerParser(),
    "mp3": OpenAIWhisperParser()
}

# 使用 MIME 类型：
handlers = {
    "application/msword": MsWordParser(),
    "application/pdf": PDFMinerParser(),
    "audio/mpeg": OpenAIWhisperParser()
}

loader = SharePointLoader(document_library_id="...",
                            handlers=handlers # 将 handlers 传递给 SharePointLoader
                            )

如果多个文件扩展名映射到相同的 MIME 类型，则最后一个字典项将生效。示例：

# 'jpg' 和 'jpeg' 都映射到 'image/jpeg' MIME 类型。SecondParser() 将用于
# 解析所有 jpg/jpeg 文件。
handlers = {
    "jpg": FirstParser(),
    "jpeg": SecondParser()
}

将这些文档连接到 Claude、VSCode 等，通过 MCP 获取实时答案。

在 GitHub 上编辑此页面或提交问题。

Popular Providers

Integrations by component

先决条件

🧑 从 SharePoint 文档库摄取文档的说明

🔑 身份验证

🗂️ 文档加载器

📑 从文档库目录加载文档

📑 从文档 ID 列表加载文档

📑 选择支持的文件类型和首选解析器

​先决条件

​🧑 从 SharePoint 文档库摄取文档的说明

​🔑 身份验证

​🗂️ 文档加载器

​📑 从文档库目录加载文档

​📑 从文档 ID 列表加载文档

​📑 选择支持的文件类型和首选解析器

先决条件

🧑 从 SharePoint 文档库摄取文档的说明

🔑 身份验证

🗂️ 文档加载器

📑 从文档库目录加载文档

📑 从文档 ID 列表加载文档

📑 选择支持的文件类型和首选解析器