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

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

特殊值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（以及_recursive=true中的子文件夹）中搜索query
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 参考：PromptTemplate

使用 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")

相关

• 检索器 概念指南
• 检索器 操作指南