Skip to main content
Firestore 是一种无服务器的面向文档的数据库，可按需扩展。通过 Firestore 的 LangChain 集成，扩展您的数据库应用以构建 AI 驱动的体验。
本笔记本介绍如何使用 FirestoreVectorStore 类通过 Firestore 存储向量并进行查询。 Open In Colab

​
开始之前

要运行此笔记本，您需要完成以下操作： 在确认可以访问此笔记本运行时环境中的数据库后，请填写以下值并在运行示例脚本之前运行该单元格。 
# @markdown Please specify a source for demo purpose.
COLLECTION_NAME = "test"  # @param {type:"CollectionReference"|"string"}

​
🦜🔗 库安装

集成位于其自己的 langchain-google-firestore 包中，因此我们需要安装它。在此笔记本中，我们还将安装 langchain-google-genai 以使用 Google Generative 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 Please fill in the value below with your Google Cloud project ID and then run the cell.

PROJECT_ID = "extensions-testing"  # @param {type:"string"}

# Set the project 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 Generative AI 的嵌入。 
from langchain_google_firestore import FirestoreVectorStore
from langchain_google_vertexai import VertexAIEmbeddings

embedding = VertexAIEmbeddings(
    model_name="textembedding-gecko@latest",
    project=PROJECT_ID,
)

# Sample data
ids = ["apple", "banana", "orange"]
fruits_texts = ['{"name": "apple"}', '{"name": "banana"}', '{"name": "orange"}']

# Create a vector store
vector_store = FirestoreVectorStore(
    collection="fruits",
    embedding=embedding,
)

# Add the fruits to the vector store
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,
)
Edit this page on GitHub or file an issue.
Connect these docs to Claude, VSCode, and more via MCP for real-time answers.