Google Firestore (原生模式)
Firestore 是一个无服务器的文档导向数据库，能够根据需求进行扩展。扩展您的数据库应用程序，利用 Firestore 的 Langchain 集成构建 AI 驱动的体验。
本笔记本介绍如何使用 Firestore 存储向量并使用 FirestoreVectorStore 类查询它们。
开始之前
要运行此笔记本，您需要执行以下操作：
在确认在此笔记本的运行时环境中访问数据库后，填写以下值并在运行示例脚本之前运行该单元格。
# @markdown 请指定一个用于演示的来源。
COLLECTION_NAME = "test" # @param {type:"CollectionReference"|"string"}
🦜🔗 库安装
集成存在于它自己的 langchain-google-firestore 包中，因此我们需要安装它。对于这个笔记本，我们还将安装 langchain-google-genai 以使用 Google 生成式 AI 嵌入。
%pip install -upgrade --quiet langchain-google-firestore langchain-google-vertexai
仅限 Colab：取消注释以下单元以重启内核，或使用按钮重启内核。对于 Vertex AI Workbench，您可以使用顶部的按钮重启终端。
# # Automatically restart kernel after installs so that your environment can access the new packages
# import IPython
# app = IPython.Application.instance()
# app.kernel.do_shutdown(True)
☁ 设置您的 Google Cloud 项目
设置您的 Google Cloud 项目，以便您可以在此笔记本中利用 Google Cloud 资源。
如果您不知道您的项目 ID，请尝试以下方法：
- 运行
gcloud config list。 - 运行
gcloud projects list。 - 查看支持页面：查找项目 ID。
# @markdown 请在下面填写您的 Google Cloud 项目 ID，然后运行该单元格。
PROJECT_ID = "extensions-testing" # @param {type:"string"}
# 设置项目 ID
!gcloud config set project {PROJECT_ID}
🔐 身份验证
作为登录此笔记本的 IAM 用户对 Google Cloud 进行身份验证，以访问您的 Google Cloud 项目。
- 如果您使用 Colab 来运行此笔记本，请使用下面的单元并继续。
- 如果您使用 Vertex AI Workbench，请查看 此处 的设置说明。
from google.colab import auth
auth.authenticate_user()
基本用法
初始化 FirestoreVectorStore
FirestoreVectorStore 允许您在 Firestore 数据库中存储新的向量。您可以使用它存储来自任何模型的嵌入，包括 Google 生成式 AI 的嵌入。
from langchain_google_firestore import FirestoreVectorStore
from langchain_google_vertexai import VertexAIEmbeddings
embedding = VertexAIEmbeddings(
model_name="textembedding-gecko@latest",
project=PROJECT_ID,
)
# 示例数据
ids = ["apple", "banana", "orange"]
fruits_texts = ['{"name": "apple"}', '{"name": "banana"}', '{"name": "orange"}']
# 创建向量存储
vector_store = FirestoreVectorStore(
collection="fruits",
embedding=embedding,
)
# 将水果添加到向量存储
vector_store.add_texts(fruits_texts, ids=ids)
作为简化，您可以使用 from_texts 和 from_documents 方法在单一步骤中初始化并添加向量。
vector_store = FirestoreVectorStore.from_texts(
collection="fruits",
texts=fruits_texts,
embedding=embedding,
)
from langchain_core.documents import Document
fruits_docs = [Document(page_content=fruit) for fruit in fruits_texts]
vector_store = FirestoreVectorStore.from_documents(
collection="fruits",
documents=fruits_docs,
embedding=embedding,
)
删除向量
您可以使用 delete 方法从数据库中删除带有向量的文档。您需要提供要删除的向量的文档 ID。这将从数据库中移除整个文档，包括它可能具有的任何其他字段。
vector_store.delete(ids)
更新向量
更新向量类似于添加它们。您可以使用 add 方法通过提供文档 ID 和新向量来更新文档的向量。
fruit_to_update = ['{"name": "apple","price": 12}']
apple_id = "apple"
vector_store.add_texts(fruit_to_update, ids=[apple_id])
相似性搜索
您可以使用 FirestoreVectorStore 对存储的向量执行相似性搜索。这对于查找相似的文档或文本非常有用。
vector_store.similarity_search("I like fuji apples", k=3)
vector_store.max_marginal_relevance_search("fuji", 5)
您可以通过使用 filters 参数为搜索添加预过滤。这对于按特定字段或值进行过滤非常有用。
from google.cloud.firestore_v1.base_query import FieldFilter
vector_store.max_marginal_relevance_search(
"fuji", 5, filters=FieldFilter("content", "==", "apple")
)
自定义连接与身份验证
from google.api_core.client_options import ClientOptions
from google.cloud import firestore
from langchain_google_firestore import FirestoreVectorStore
client_options = ClientOptions()
client = firestore.Client(client_options=client_options)
# Create a vector store
vector_store = FirestoreVectorStore(
collection="fruits",
embedding=embedding,
client=client,
)