跳至主要内容

Microsoft SharePoint

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

此笔记本涵盖了如何从 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. 按照此 文档 中的说明将以下SCOPESoffline_accessSites.Read.All)添加到您的应用程序。
  6. 要从您的文档库中检索文件,您需要它的 ID。要获取它,您需要租户名称集合 ID子站点 ID 的值。
  7. 要查找您的租户名称,请按照此 文档 中的说明进行操作。获取此信息后,只需从值中删除.onmicrosoft.com,并将剩余部分保留为您的租户名称
  8. 要获取您的集合 ID子站点 ID,您需要您的SharePoint站点名称。您的SharePoint 站点 URL 格式如下:https://<tenant-name>.sharepoint.com/sites/<site-name>。此 URL 的最后一部分是站点名称
  9. 要获取站点集合 ID,请在浏览器中访问此 URL:https://<tenant>.sharepoint.com/sites/<site-name>/_api/site/id,并复制Edm.Guid 属性的值。
  10. 要获取子站点 ID(或 Web 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 以获取您的文档库 ID。第一步是确保您已使用与您的SharePoint 站点关联的帐户登录。然后,您需要向https://graph.microsoft.com/v1.0/sites/<SharePoint site ID>/drive 发出请求,响应将返回一个有效负载,其中包含一个名为id 的字段,该字段保存您的文档库 ID 的 ID。

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

🔑 身份验证

默认情况下,SharePointLoader 预计CLIENT_IDCLIENT_SECRET 的值必须存储为名为O365_CLIENT_IDO365_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")
API 参考:SharePointLoader

身份验证完成后,加载器将在~/.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)
API 参考:SharePointLoader

🗂️ 文档加载器

📑 从文档库目录加载文档

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()
API 参考:SharePointLoader

如果您收到无法为该段找到资源错误,请尝试使用folder_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_idfolder_pathdocuments_ids,加载器将加载根目录。

# loads documents from root directory
loader = SharePointLoader(document_library_id="YOUR DOCUMENT LIBRARY ID", auth_with_token=True)
documents = loader.load()

结合recursive=True,您可以轻松地从整个 SharePoint 加载所有文档

# loads documents from root directory
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()
API 参考:SharePointLoader

此页面对您有帮助吗?


您也可以在 GitHub 上留下详细的反馈 在 GitHub 上.