Skip to main content
Open In ColabOpen on GitHub

Google云端硬盘

本笔记本介绍如何从 Google Drive 中检索文档。

先决条件​

  1. 创建一个 Google Cloud 项目或使用现有项目
  2. 启用 Google Drive API
  3. 授权桌面应用的凭据
  4. pip install --upgrade google-api-python-client google-auth-httplib2 google-auth-oauthlib

检索 Google 文档​

默认情况下，GoogleDriveRetriever 期望 credentials.json 文件位于 ~/.credentials/credentials.json，但这可以通过 GOOGLE_ACCOUNT_FILE 环境变量进行配置。 token.json 的位置使用相同的目录（或使用参数 token_path）。请注意，token.json 将在您首次使用检索器时自动创建。

GoogleDriveRetriever 可以检索一些选定的文件。

默认情况下，如果您使用 folder_id，此文件夹中的所有文件都可以检索到 Document。

您可以从 URL 获取您的文件夹和文档 ID：

特殊值 root 用于您的个人主页。

from langchain_googledrive.retrievers import GoogleDriveRetriever

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

retriever = GoogleDriveRetriever(
    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)

这是可以更新或自定义的。请参阅 GoogleDriveRetriever 的文档。

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

%pip install --upgrade --quiet  unstructured
retriever.invoke("machine learning")

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

模板描述
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使用特定的 mime_type 并在 folder_id 中搜索 query
retriever = GoogleDriveRetriever(
    template="gdrive-query",  # Search everywhere
    num_results=2,  # But take only 2 documents
)
for doc in retriever.invoke("machine learning"):
    print("---")
    print(doc.page_content.strip()[:60] + "...")

否则，您可以使用专用的 PromptTemplate 来自定义提示。

from langchain_core.prompts import PromptTemplate

retriever = GoogleDriveRetriever(
    template=PromptTemplate(
        input_variables=["query"],
        # See https://developers.google.com/drive/api/guides/search-files
        template="(fullText contains '{query}') "
        "and mimeType='application/vnd.google-apps.document' "
        "and modifiedTime > '2000-01-01T00:00:00' "
        "and trashed=false",
    ),
    num_results=2,
    # See https://developers.google.com/drive/api/v3/reference/files/list
    includeItemsFromAllDrives=False,
    supportsAllDrives=False,
)
for doc in retriever.invoke("machine learning"):
    print(f"{doc.metadata['name']}:")
    print("---")
    print(doc.page_content.strip()[:60] + "...")
API Reference:PromptTemplate

使用 Google Drive 的 description 元数据​

每个 Google Drive 文件都在元数据中有一个 description 字段（参见 文件的详情）。 使用 snippets 模式即可返回选定文件的描述。

retriever = GoogleDriveRetriever(
    template="gdrive-mime-type-in-folder",
    folder_id=folder_id,
    mime_type="application/vnd.google-apps.document",  # Only Google Docs
    num_results=2,
    mode="snippets",
    includeItemsFromAllDrives=False,
    supportsAllDrives=False,
)
retriever.invoke("machine learning")