Skip to main content
本 notebook 介绍如何从 Google Drive 检索文档。

前提条件

  1. 创建一个 Google Cloud 项目或使用现有项目
  2. 启用 Google Drive API
  3. 为桌面应用授权凭证
  4. pip install -U 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 -qU  unstructured
retriever.invoke("machine learning")
可以自定义选择文件的条件。提供了一组预定义过滤器:
模板描述
gdrive-all-in-folder返回 folder_id 中所有兼容文件
gdrive-query在所有云盘中搜索 query
gdrive-by-name搜索名称为 query 的文件
gdrive-query-in-folderfolder_id 中搜索 query_recursive=true 时包括子文件夹)
gdrive-mime-type搜索特定 mime_type
gdrive-mime-type-in-folderfolder_id 中搜索特定 mime_type
gdrive-query-with-mime-type搜索具有特定 mime_typequery
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] + "...")

使用 Google Drive 的”描述”元数据

每个 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")