Google Drive

Google Drive 是由 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

loader = GoogleDriveLoader(
    folder_id="1yucgL9WGgWZdM1TOuKkeghlPizuzMYb5",
    token_path="/path/where/you/want/token/to/be/created/google_token.json",
    # 可选：配置是否递归获取子文件夹中的文件。默认为 False。
    recursive=False,
)

docs = loader.load()

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

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

传递可选文件加载器

在处理非 Google Docs 和 Google Sheets 的文件时，传递一个可选的文件加载器给 GoogleDriveLoader 是非常有帮助的。如果传递了文件加载器，则该文件加载器将用于没有 Google Docs 或 Google Sheets MIME 类型的文档。以下是如何使用文件加载器从 Google Drive 加载 Excel 文档的示例。

from langchain_community.document_loaders import UnstructuredFileIOLoader
from langchain_google_community import 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 Docs/Sheets 的文件夹：

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'

# 使用高级版本。
from langchain_googledrive.document_loaders import GoogleDriveLoader

loader = GoogleDriveLoader(
    folder_id=folder_id,
    recursive=False,
    num_results=2,  # 最大加载文件数
)

默认情况下，所有具有这些 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 (GSheet)
application/vnd.google.colaboratory (Notebook 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 Loader 处理的每个文件的授权身份可以与每个文档的元数据一起加载。

from langchain_google_community import GoogleDriveLoader

loader = GoogleDriveLoader(
    folder_id=folder_id,
    load_auth=True,
    # 可选：配置是否为每个文档加载授权身份。
)

doc = loader.load()

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

doc[0].metadata

加载扩展元数据

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

full_path - 文件在 Google Drive 中的完整路径。
owner - 文件的拥有者。
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()

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

doc[0].metadata

自定义搜索模式

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

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

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

模板	描述
gdrive-all-in-folder	返回来自 `folder_id` 的所有兼容文件
gdrive-query	在所有驱动器中搜索 `query`
gdrive-by-name	根据名称 `query` 搜索文件
gdrive-query-in-folder	在 `folder_id` 中搜索 `query`（如果 `recursive=true` 也包括子文件夹）
gdrive-mime-type	搜索特定的 `mime_type`
gdrive-mime-type-in-folder	在 `folder_id` 中搜索特定的 `mime_type`
gdrive-query-with-mime-type	使用特定的 `mime_type` 搜索 `query`
gdrive-query-with-mime-type-and-folder	在 `folder_id` 中使用特定的 `mime_type` 搜索 `query`

loader = GoogleDriveLoader(
    folder_id=folder_id,
    recursive=False,
    template="gdrive-query",  # 默认使用的模板
    query="machine learning",
    num_results=2,  # 最大加载文件数量
    supportsAllDrives=False,  # GDrive `list()` 参数
)
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",
    ),  # 默认使用的模板
    query="machine learning",
    query_name="ML",
    num_results=2,  # 最大加载文件数量
)
for doc in loader.load():
    print("---")
    print(doc.page_content.strip()[:60] + "...")

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

项目符号
链接
表格
标题

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

GSlide 和 GSheet 的模式

参数 mode 接受不同的值：

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

参数 gslide_mode 接受不同的值：

"single" : 一个文档带有 <PAGE BREAK>
"slide" : 每张幻灯片一个文档
"elements" : 每个元素一个文档。

loader = GoogleDriveLoader(
    template="gdrive-mime-type",
    mime_type="application/vnd.google-apps.presentation",  # 仅限 GSlide 文件
    gslide_mode="slide",
    num_results=2,  # 最大加载文件数量
)
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",  # 仅限 GSheet 文件
    gsheet_mode="elements",
    num_results=2,  # 最大加载文件数量
)
for doc in loader.load():
    print("---")
    print(doc.page_content.strip()[:60] + "...")

高级用法

所有 Google 文件在元数据中都有一个 'description' 字段。该字段可用于记忆文档的摘要或其他索引标签（参见方法 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 Drive

前提条件

🧑 导入您的 Google Docs 数据的说明

传递可选文件加载器

扩展用法

加载授权身份

加载扩展元数据

自定义搜索模式

GSlide 和 GSheet 的模式

高级用法

相关

此页面是否有帮助？

您还可以留下详细的反馈在 GitHub 上

Google Drive

前提条件​

🧑 导入您的 Google Docs 数据的说明​

传递可选文件加载器​

扩展用法​

加载授权身份​

加载扩展元数据​

自定义搜索模式​

GSlide 和 GSheet 的模式​

高级用法​

相关​

此页面是否有帮助？

您还可以留下详细的反馈 在 GitHub 上

前提条件

🧑 导入您的 Google Docs 数据的说明

传递可选文件加载器

扩展用法

加载授权身份

加载扩展元数据

自定义搜索模式

GSlide 和 GSheet 的模式

高级用法

相关

您还可以留下详细的反馈在 GitHub 上