谷歌网盘

Google Drive is a file storage and synchronization service developed by Google.

本笔记本介绍如何从Google Drive加载文档。目前仅支持Google Docs。

先决条件

创建一个 Google Cloud 项目或使用现有项目
启用 Google Drive API
为桌面应用程序授权凭据
pip install --upgrade google-api-python-client google-auth-httplib2 google-auth-oauthlib

🧑 导入 Google Docs 数据的说明

将环境变量 GOOGLE_APPLICATION_CREDENTIALS 设置为空字符串（""）。

默认情况下，GoogleDriveLoader 期望 credentials.json 文件位于 ~/.credentials/credentials.json，但可以使用 credentials_path 关键字参数进行配置。token.json 也是如此 - 默认路径：~/.credentials/token.json，构造函数参数：token_path。

首次使用 GoogleDriveLoader 时，您的浏览器中将显示用于用户身份验证的同意屏幕。身份验证后，token.json 将在指定路径或默认路径下自动创建。此外，如果该路径下已存在 token.json，则不会提示您进行身份验证。

GoogleDriveLoader 可以从 Google Docs 文档 ID 列表或文件夹 ID 加载。您可以从 URL 中获取您的文件夹和文档 ID：

文件夹: https://drive.google.com/drive/u/0/folders/1yucgL9WGgWZdM1TOuKkeghlPizuzMYb5 -> 文件夹ID为 "1yucgL9WGgWZdM1TOuKkeghlPizuzMYb5"
文档: https://docs.google.com/document/d/1bfaMQ18_i56204VaQDVeAFpqEijJTgvurupdEDiaUQw/edit -> 文档 ID 为 "1bfaMQ18_i56204VaQDVeAFpqEijJTgvurupdEDiaUQw"

%pip install --upgrade --quiet langchain-google-community[drive]

from langchain_google_community import GoogleDriveLoader

API 参考：GoogleDriveLoader

loader = GoogleDriveLoader(
    folder_id="1yucgL9WGgWZdM1TOuKkeghlPizuzMYb5",
    token_path="/path/where/you/want/token/to/be/created/google_token.json",
    # Optional: configure whether to recursively fetch files from subfolders. Defaults to False.
    recursive=False,
)

docs = loader.load()

当您默认传递 folder_id 时，将加载所有类型为文档、表格和 PDF 的文件。您可以通过传递 file_types 参数来修改此行为

loader = GoogleDriveLoader(
    folder_id="1yucgL9WGgWZdM1TOuKkeghlPizuzMYb5",
    file_types=["document", "sheet"],
    recursive=False,
)

传入可选的文件加载器

在处理除 Google 文档和 Google 表格之外的文件时，向 GoogleDriveLoader 传递一个可选的文件加载器可能会有所帮助。如果您传入了一个文件加载器，该加载器将用于处理不具有 Google 文档或 Google 表格 MIME 类型的文档。以下是一个使用文件加载器从 Google 云端硬盘加载 Excel 文档的示例。

from langchain_community.document_loaders import UnstructuredFileIOLoader
from langchain_google_community import GoogleDriveLoader

API 参考：UnstructuredFileIOLoader | GoogleDriveLoader

file_id = "1x9WBtFPWMEAdjcJzPScRsjpjQvpSo_kz"
loader = GoogleDriveLoader(
    file_ids=[file_id],
    file_loader_cls=UnstructuredFileIOLoader,
    file_loader_kwargs={"mode": "elements"},
)

docs = loader.load()

docs[0]

您也可以使用以下模式处理包含混合文件和 Google 文档/表格的文件夹：

folder_id = "1asMOHY1BqBS84JcRbOag5LOJac74gpmD"
loader = GoogleDriveLoader(
    folder_id=folder_id,
    file_loader_cls=UnstructuredFileIOLoader,
    file_loader_kwargs={"mode": "elements"},
)

docs = loader.load()

docs[0]

扩展用法

一个外部（非官方）组件可以管理 Google Drive 的复杂性：langchain-googledrive 它与 langchain_community.document_loaders.GoogleDriveLoader 兼容，并可替代其使用。

为了与容器兼容，身份验证使用环境变量 ̀GOOGLE_ACCOUNT_FILE 指向凭证文件（用于用户或服务）。

%pip install --upgrade --quiet  langchain-googledrive

folder_id = "root"
# folder_id='1yucgL9WGgWZdM1TOuKkeghlPizuzMYb5'

# Use the advanced version.
from langchain_googledrive.document_loaders import GoogleDriveLoader

loader = GoogleDriveLoader(
    folder_id=folder_id,
    recursive=False,
    num_results=2,  # Maximum number of file to load
)

默认情况下，所有具有这些 MIME 类型的文件都可以转换为 Document。

text/text
text/plain
text/html
text/csv
text/markdown
image/png
image/jpeg
application/epub+zip
application/pdf
application/rtf
application/vnd.google-apps.document (GDoc)
application/vnd.google-apps.presentation（GSlide）
application/vnd.google-apps.spreadsheet（Google 表格）
application/vnd.google.colaboratory（Colab 笔记本）
application/vnd.openxmlformats-officedocument.presentationml.presentation (PPTX)
application/vnd.openxmlformats-officedocument.wordprocessingml.document (DOCX)

可以更新或自定义此项。请参阅GDriveLoader的文档。

但是，必须安装相应的包。

%pip install --upgrade --quiet  unstructured

for doc in loader.load():
    print("---")
    print(doc.page_content.strip()[:60] + "...")

正在加载身份验证标识

Google Drive 加载器摄入的每个文件的授权身份可以随每个文档的元数据一起加载。

from langchain_google_community import GoogleDriveLoader

loader = GoogleDriveLoader(
    folder_id=folder_id,
    load_auth=True,
    # Optional: configure whether to load authorized identities for each Document.
)

doc = loader.load()

API 参考：GoogleDriveLoader

您可以传递 load_auth=True，以便将 Google Drive 文档访问身份添加到元数据中。

doc[0].metadata

正在加载扩展元数据

每个文档的元数据中还可以获取以下额外字段：

full_path - Google Drive 中文件的完整路径。
所有者 - 文件的所有者。
size - 文件的大小。

from langchain_google_community import GoogleDriveLoader

loader = GoogleDriveLoader(
    folder_id=folder_id,
    load_extended_matadata=True,
    # Optional: configure whether to load extended metadata for each Document.
)

doc = loader.load()

API 参考：GoogleDriveLoader

您可以传递 load_extended_matadata=True，以将 Google Drive 文档的扩展详细信息添加到元数据中。

doc[0].metadata

自定义搜索模式

所有与 Google list() API 兼容的参数均可设置。

要指定 Google 请求的新模式，您可以使用 PromptTemplate()。提示的变量可以在构造函数中通过 kwargs 进行设置。提供了一些预格式化的请求（使用 {query}、{folder_id} 和/或 {mime_type}）：

您可以自定义选择文件的标准。提供了一组预定义的过滤器：

模板	描述
gdrive-all-in-folder	Return all compatible files from a `folder_id`
gdrive-query	Search `query` in all drives
gdrive-by-name	Search file with name `query`
gdrive-query-in-folder	Search `query` in `folder_id` (and sub-folders if `recursive=true`)
gdrive-mime-type	Search a specific `mime_type`
gdrive-mime-type-in-folder	Search a specific `mime_type` in `folder_id`
gdrive-query-with-mime-type	Search `query` with a specific `mime_type`
gdrive-query-with-mime-type-and-folder	Search `query` with a specific `mime_type` and in `folder_id`

loader = GoogleDriveLoader(
    folder_id=folder_id,
    recursive=False,
    template="gdrive-query",  # Default template to use
    query="machine learning",
    num_results=2,  # Maximum number of file to load
    supportsAllDrives=False,  # GDrive `list()` parameter
)
for doc in loader.load():
    print("---")
    print(doc.page_content.strip()[:60] + "...")

您可以自定义您的模式。

from langchain_core.prompts.prompt import PromptTemplate

loader = GoogleDriveLoader(
    folder_id=folder_id,
    recursive=False,
    template=PromptTemplate(
        input_variables=["query", "query_name"],
        template="fullText contains '{query}' and name contains '{query_name}' and trashed=false",
    ),  # Default template to use
    query="machine learning",
    query_name="ML",
    num_results=2,  # Maximum number of file to load
)
for doc in loader.load():
    print("---")
    print(doc.page_content.strip()[:60] + "...")

API 参考：PromptTemplate

转换可以以 Markdown 格式进行管理：

项目符号
链接
表
标题

将属性 return_link 设置为 True 以导出链接。

GSlide 和 GSheet 的模式

参数 mode 接受不同的值：

"document"：返回每个文档的正文
"snippets": 返回每个文件的描述（在 Google Drive 文件的元数据中设置）。

参数 gslide_mode 接受不同的值：

"single"：包含 <PAGE BREAK> 的单个文档
"幻灯片”：每张幻灯片对应一份文档
"elements"：每个元素对应一个文档。

loader = GoogleDriveLoader(
    template="gdrive-mime-type",
    mime_type="application/vnd.google-apps.presentation",  # Only GSlide files
    gslide_mode="slide",
    num_results=2,  # Maximum number of file to load
)
for doc in loader.load():
    print("---")
    print(doc.page_content.strip()[:60] + "...")

参数 gsheet_mode 接受不同的值：

"single": 每行生成一个文档
"elements"：一个包含 Markdown 数组和 <PAGE BREAK> 标签的文档。

loader = GoogleDriveLoader(
    template="gdrive-mime-type",
    mime_type="application/vnd.google-apps.spreadsheet",  # Only GSheet files
    gsheet_mode="elements",
    num_results=2,  # Maximum number of file to load
)
for doc in loader.load():
    print("---")
    print(doc.page_content.strip()[:60] + "...")

高级用法

所有 Google 文件在元数据中都有一个“描述”字段。此字段可用于存储文档摘要或其他已索引的标签（参见方法 lazy_update_description_with_summary()）。

如果您使用 mode="snippet"，则仅将描述用于正文。否则，metadata['summary'] 包含该字段。

有时，可以使用特定的过滤器从文件名中提取某些信息，以选择符合特定条件的文件。您可以使用过滤器。

有时，会返回许多文档。没有必要同时将所有文档加载到内存中。您可以使用方法的惰性版本，一次获取一个文档。最好使用复杂查询来代替递归搜索。如果您激活了 recursive=True，则必须对每个文件夹应用查询。

import os

loader = GoogleDriveLoader(
    gdrive_api_file=os.environ["GOOGLE_ACCOUNT_FILE"],
    num_results=2,
    template="gdrive-query",
    filter=lambda search, file: "#test" not in file.get("description", ""),
    query="machine learning",
    supportsAllDrives=False,
)
for doc in loader.load():
    print("---")
    print(doc.page_content.strip()[:60] + "...")

文档加载器概念指南
文档加载器操操作指南

先决条件​

🧑 导入 Google Docs 数据的说明​

传入可选的文件加载器​

扩展用法​

正在加载身份验证标识​

正在加载扩展元数据​

自定义搜索模式

GSlide 和 GSheet 的模式​

高级用法​

相关​

先决条件

🧑 导入 Google Docs 数据的说明

传入可选的文件加载器

扩展用法

正在加载身份验证标识

正在加载扩展元数据

GSlide 和 GSheet 的模式

高级用法

相关