谷歌云盘
本笔记涵盖了如何从谷歌云盘
检索文档。
先决条件
- 创建一个谷歌云项目或使用现有项目
- 启用谷歌云盘 API
- 为桌面应用程序授权凭据(详细步骤)
- 运行
pip install --upgrade google-api-python-client google-auth-httplib2 google-auth-oauthlib
检索谷歌文档
默认情况下,GoogleDriveRetriever
期望credentials.json
文件位于~/.credentials/credentials.json
,但可以使用GOOGLE_ACCOUNT_FILE
环境变量进行配置。
token.json
的位置使用相同的目录(或使用参数token_path
)。请注意,第一次使用检索器时,token.json
将被自动创建。
GoogleDriveRetriever
可以通过一些请求检索一组文件。
默认情况下,如果使用folder_id
,则可以将此文件夹中的所有文件检索到Document
。
您可以从以下网址获取文件夹和文档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
中搜索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", # 在所有地方搜索
num_results=2, # 但只取2个文档
)
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"],
# 请参阅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,
# 请参阅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", # 仅限 Google 文档
num_results=2,
mode="snippets",
includeItemsFromAllDrives=False,
supportsAllDrives=False,
)
retriever.invoke("machine learning")
[20]