Skip to main content
Open In ColabOpen on GitHub

Google Drive

本笔记本介绍如何从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")

这个页面有帮助吗？