Microsoft OneNote
本笔记本介绍了如何从 OneNote
加载文档。
先决条件
- 按照 Microsoft identity platform 说明注册应用程序。
- 注册完成后,Azure 门户将显示应用注册的“概览”窗格。您会看到应用程序(客户端)ID。也称为
client ID
,此值在 Microsoft identity platform 中唯一标识您的应用程序。 - 在步骤 **项目 1** 中,您可以将重定向 URI 设置为
https://127.0.0.1:8000/callback
- 在步骤 **项目 1** 中,在“应用程序密钥”部分下生成新密码 (
client_secret
)。 - 按照此 文档 中的说明,将以下
SCOPES
(Notes.Read
) 添加到您的应用程序。 - 您需要使用命令
pip install msal
和pip install beautifulsoup4
安装 msal 和 bs4 包。 - 在步骤结束时,您必须具有以下值
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")
身份验证完成后,加载器将在 ~/.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)
或者,您也可以将令牌直接传递给加载器。当您想要使用由另一个应用程序生成的令牌进行身份验证时,这非常有用。例如,您可以使用 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")
🗂️ 文档加载器
📑 从 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()
📑 从页面 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()