Skip to main content
Open In ColabOpen on GitHub

Microsoft OneNote

本笔记本介绍如何从 OneNote 加载文档。

先决条件​

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

🧑 从 OneNote 引入文档的操作说明​

🔑 身份验证​

默认情况下，OneNoteLoader 期望 CLIENT_ID 和 CLIENT_SECRET 的值分别存储为名为 MS_GRAPH_CLIENT_ID 和 MS_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 Reference:OneNoteLoader

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

🗂️ 文档加载器​

📑 从 OneNote 笔记本加载页面​

OneNoteLoader 可以加载存储在 OneDrive 中的 OneNote 笔记本的页面。您可以指定 notebook_name、section_name、page_title 的任意组合来分别筛选特定笔记本下的页面、特定分区下的页面或具有特定标题的页面。例如，您想加载 OneDrive 中任何笔记本里名为 Recipes 的分区下的所有页面。

from langchain_community.document_loaders.onenote import OneNoteLoader

loader = OneNoteLoader(section_name="Recipes", auth_with_token=True)
documents = loader.load()
API Reference: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 Reference:OneNoteLoader