微软 OneDrive
Microsoft OneDrive (formerly
SkyDrive) is a file hosting service operated by Microsoft.
本笔记本介绍如何从OneDrive加载文档。默认情况下,文档加载器会加载pdf、doc、docx和txt文件。您可以通过提供相应的解析器来加载其他文件类型(详见下文)。
先决条件
- 按照Microsoft 身份平台的说明注册应用程序。
- 注册完成后,Azure 门户会显示应用注册的“概述”窗格。您将看到“应用程序 (客户端) ID"。该值也称为
client ID,用于在 Microsoft 身份平台中唯一标识您的应用程序。 - 在您遵循第 1 项的步骤期间,您可以将重定向 URI 设置为
http://localhost:8000/callback - 在您将在第 1 项中执行的步骤期间,请在“应用程序密钥”部分生成一个新密码(
client_secret)。 - 请按照此文档中的说明,将以下
SCOPES(offline_access和Files.Read.All)添加到您的应用程序中。 - 访问 Graph Explorer Playground 以获取您的
OneDrive ID。第一步是确保您已使用与 OneDrive 账户关联的账户登录。然后,您需要向https://graph.microsoft.com/v1.0/me/drive发出请求,响应将返回一个包含字段id的有效负载,该字段保存您的 OneDrive 账户 ID。 - 您需要使用命令
pip install o365安装 o365 包。 - 在完成这些步骤后,您必须获得以下值:
CLIENT_IDCLIENT_SECRETDRIVE_ID
🧑 从 OneDrive 导入文档的说明
🔑 身份验证
默认情况下,OneDriveLoader 期望 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.onedrive import OneDriveLoader
loader = OneDriveLoader(drive_id="YOUR DRIVE ID")
一旦完成身份验证,加载器会将令牌(o365_token.txt)存储在 ~/.credentials/ 文件夹中。此令牌可在日后用于身份验证,无需执行前述的复制/粘贴步骤。要使用此令牌进行身份验证,您需要在实例化加载器时将 auth_with_token 参数设置为 True。
from langchain_community.document_loaders.onedrive import OneDriveLoader
loader = OneDriveLoader(drive_id="YOUR DRIVE ID", auth_with_token=True)
🗂️ 文档加载器
📑 从 OneDrive 目录加载文档
OneDriveLoader 可以从您的 OneDrive 中的特定文件夹加载文档。例如,您想加载存储在 OneDrive 中 Documents/clients 文件夹内的所有文档。
from langchain_community.document_loaders.onedrive import OneDriveLoader
loader = OneDriveLoader(drive_id="YOUR DRIVE ID", folder_path="Documents/clients", auth_with_token=True)
documents = loader.load()
📑 从文档 ID 列表加载文档
另一种可能性是为每个要加载的文档提供一个 object_id 列表。为此,您需要查询 Microsoft Graph API 以查找所有您感兴趣的文档 ID。此 链接 提供了一系列有助于检索文档 ID 的端点。
例如,要检索存储在“文档”文件夹根目录下的所有对象的信息,您需要向以下地址发出请求:https://graph.microsoft.com/v1.0/drives/{YOUR DRIVE ID}/root/children。一旦获取了您感兴趣的 ID 列表,就可以使用以下参数实例化加载器。
from langchain_community.document_loaders.onedrive import OneDriveLoader
loader = OneDriveLoader(drive_id="YOUR DRIVE ID", object_ids=["ID_1", "ID_2"], auth_with_token=True)
documents = loader.load()
📑 选择支持的文件类型和首选解析器
默认情况下,OneDriveLoader 会使用默认解析器(见下文)加载 document_loaders/parsers/registry 中定义的文件类型。
def _get_default_parser() -> BaseBlobParser:
"""Get default mime-type based parser."""
return MimeTypeBasedParser(
handlers={
"application/pdf": PyMuPDFParser(),
"text/plain": TextParser(),
"application/msword": MsWordParser(),
"application/vnd.openxmlformats-officedocument.wordprocessingml.document": (
MsWordParser()
),
},
fallback_parser=None,
)
您可以通过向 OneDriveLoader 传递 handlers 参数来覆盖此行为。
传递一个字典,将文件扩展名(如 "doc"、"pdf" 等)
或 MIME 类型(如 "application/pdf"、"text/plain" 等)映射到解析器。
请注意,您必须单独使用文件扩展名或 MIME 类型,
不能混合使用。
文件扩展名请勿包含前导点。
# using file extensions:
handlers = {
"doc": MsWordParser(),
"pdf": PDFMinerParser(),
"mp3": OpenAIWhisperParser()
}
# using MIME types:
handlers = {
"application/msword": MsWordParser(),
"application/pdf": PDFMinerParser(),
"audio/mpeg": OpenAIWhisperParser()
}
loader = OneDriveLoader(document_library_id="...",
handlers=handlers # pass handlers to OneDriveLoader
)
如果多个文件扩展名映射到相同的 MIME 类型,则将应用字典中的最后一项。 示例:
# 'jpg' and 'jpeg' both map to 'image/jpeg' MIME type. SecondParser() will be used
# to parse all jpg/jpeg files.
handlers = {
"jpg": FirstParser(),
"jpeg": SecondParser()
}