跳到主要内容
Open In ColabOpen on GitHub

微软 OneNote

本 notebook 介绍了如何从 OneNote 加载文档。

先决条件

  1. 按照 Microsoft 身份平台 的说明注册应用程序。
  2. 注册完成后,Azure 门户会显示应用注册的“概述”窗格。您将看到“应用程序(客户端)ID”。此值也称为 客户端 ID,它在 Microsoft 身份平台中唯一标识您的应用程序。
  3. 在您将遵循的第 1 项步骤中,您可以将重定向 URI 设置为 https://:8000/callback
  4. 在您将遵循的第 1 项步骤中,在“应用程序密钥”部分下生成一个新密码(client_secret)。
  5. 按照此文档中的说明,将以下 SCOPES (Notes.Read) 添加到您的应用程序。
  6. 您需要使用命令 pip install msalpip install beautifulsoup4 安装 msal 和 bs4 包。
  7. 完成这些步骤后,您必须拥有以下值:
  • CLIENT_ID
  • CLIENT_SECRET

🧑 从 OneNote 摄取文档的说明

🔑 身份验证

默认情况下,OneNoteLoader 要求 CLIENT_IDCLIENT_SECRET 的值分别存储为名为 MS_GRAPH_CLIENT_IDMS_GRAPH_CLIENT_SECRET 的环境变量。您可以通过应用程序根目录下的 .env 文件或在脚本中使用以下命令来传递这些环境变量。

os.environ['MS_GRAPH_CLIENT_ID'] = "YOUR CLIENT ID"
os.environ['MS_GRAPH_CLIENT_SECRET'] = "YOUR CLIENT SECRET"

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

from langchain_community.document_loaders.onenote import OneNoteLoader

loader = OneNoteLoader(notebook_name="NOTEBOOK NAME", section_name="SECTION NAME", page_title="PAGE TITLE")
API 参考:OneNoteLoader

身份验证完成后,加载器将在 ~/.credentials/ 文件夹中存储一个令牌(onenote_graph_token.txt)。此令牌以后可用于身份验证,而无需重复前面解释的复制/粘贴步骤。要使用此令牌进行身份验证,您需要在实例化加载器时将 auth_with_token 参数更改为 True。

from langchain_community.document_loaders.onenote import OneNoteLoader

loader = OneNoteLoader(notebook_name="NOTEBOOK NAME", section_name="SECTION NAME", page_title="PAGE TITLE", auth_with_token=True)
API 参考:OneNoteLoader

另外,您也可以直接将令牌传递给加载器。当您想使用由另一个应用程序生成的令牌进行身份验证时,这会很有用。例如,您可以使用 Microsoft Graph Explorer 生成令牌,然后将其传递给加载器。

from langchain_community.document_loaders.onenote import OneNoteLoader

loader = OneNoteLoader(notebook_name="NOTEBOOK NAME", section_name="SECTION NAME", page_title="PAGE TITLE", access_token="TOKEN")
API 参考:OneNoteLoader

🗂️ 文档加载器

📑 从 OneNote 笔记本加载页面

OneNoteLoader 可以从 OneDrive 中存储的 OneNote 笔记本加载页面。您可以指定 notebook_namesection_namepage_title 的任意组合,分别用于筛选特定笔记本下、特定分区下或具有特定标题的页面。例如,您可能希望加载 OneDrive 中任何笔记本中名为 Recipes 的分区下的所有页面。

from langchain_community.document_loaders.onenote import OneNoteLoader

loader = OneNoteLoader(section_name="Recipes", auth_with_token=True)
documents = loader.load()
API 参考:OneNoteLoader

📑 从页面 ID 列表加载页面

另一种可能性是为每个要加载的页面提供一个 object_ids 列表。为此,您需要查询 Microsoft Graph API 以查找所有您感兴趣的文档 ID。此链接提供了有助于检索文档 ID 的端点列表。

例如,要检索存储在您笔记本中的所有页面的信息,您需要向 https://graph.microsoft.com/v1.0/me/onenote/pages 发出请求。一旦您获得了感兴趣的 ID 列表,就可以使用以下参数实例化加载器。

from langchain_community.document_loaders.onenote import OneNoteLoader

loader = OneNoteLoader(object_ids=["ID_1", "ID_2"], auth_with_token=True)
documents = loader.load()
API 参考:OneNoteLoader