谷歌 Firestore（原生模式）

Firestore 是一个无服务器的面向文档的数据库，可扩展以满足任何需求。通过 Firestore 的 Langchain 集成，扩展您的数据库应用程序以构建基于人工智能的体验。

本笔记将介绍如何使用 Firestore 存储向量，并使用 FirestoreVectorStore 类进行查询。

开始之前

要运行此笔记，您需要执行以下操作：

• 创建 Google Cloud 项目

• 启用 Firestore API

• 创建 Firestore 数据库

在笔记的运行时环境中确认对数据库的访问权限后，填写以下值并在运行示例脚本之前运行单元格。

# @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，您可以使用顶部的按钮重新启动终端。

# # 安装后自动重新启动内核，以便您的环境可以访问新的包
# 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)
# 创建一个向量存储
vector_store = FirestoreVectorStore(
    collection="fruits",
    embedding=embedding,
    client=client,
)