Google Spanner
Spanner 是一款高度可扩展的数据库，它将无限的可扩展性与关系语义相结合，例如二级索引、强一致性、模式和 SQL，在一个简单的解决方案中提供 99.999% 的可用性。
此笔记本介绍了如何使用 Spanner 与 SpannerVectorStore 类进行向量搜索。
在 GitHub 上了解有关此包的更多信息。
开始之前
要运行此笔记本，您需要执行以下操作
🦜🔗 库安装
此集成位于其自己的 langchain-google-spanner 包中，因此我们需要安装它。
%pip install --upgrade --quiet langchain-google-spanner
Note: you may need to restart the kernel to use updated packages.
仅限 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)
🔐 身份验证
以登录到此笔记本的 IAM 用户身份向 Google Cloud 进行身份验证，以便访问您的 Google Cloud 项目。
- 如果您使用 Colab 运行此笔记本，请使用以下单元格并继续。
- 如果您使用 Vertex AI Workbench，请查看设置说明 这里.
from google.colab import auth
auth.authenticate_user()
☁ 设置您的 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 = "my-project-id" # @param {type:"string"}
# Set the project id
!gcloud config set project {PROJECT_ID}
💡 API 启用
langchain-google-spanner 包要求您 启用 Spanner API 在您的 Google Cloud 项目中。
# enable Spanner API
!gcloud services enable spanner.googleapis.com
基本用法
设置 Spanner 数据库值
在 Spanner 实例页面 中查找您的数据库值。
# @title Set Your Values Here { display-mode: "form" }
INSTANCE = "my-instance" # @param {type: "string"}
DATABASE = "my-database" # @param {type: "string"}
TABLE_NAME = "vectors_search_data" # @param {type: "string"}
初始化表
SpannerVectorStore 类实例需要一个具有 id、content 和 embeddings 列的数据库表。
init_vector_store_table() 辅助方法可用于创建具有正确模式的表。
from langchain_google_spanner import SecondaryIndex, SpannerVectorStore, TableColumn
SpannerVectorStore.init_vector_store_table(
instance_id=INSTANCE,
database_id=DATABASE,
table_name=TABLE_NAME,
id_column="row_id",
metadata_columns=[
TableColumn(name="metadata", type="JSON", is_null=True),
TableColumn(name="title", type="STRING(MAX)", is_null=False),
],
secondary_indexes=[
SecondaryIndex(index_name="row_id_and_title", columns=["row_id", "title"])
],
)
创建嵌入类实例
您可以使用任何 LangChain 嵌入模型。您可能需要启用 Vertex AI API 才能使用 VertexAIEmbeddings。我们建议您为生产环境设置嵌入模型的版本，详细了解 文本嵌入模型。
# enable Vertex AI API
!gcloud services enable aiplatform.googleapis.com
from langchain_google_vertexai import VertexAIEmbeddings
embeddings = VertexAIEmbeddings(
model_name="textembedding-gecko@latest", project=PROJECT_ID
)
SpannerVectorStore
要初始化 SpannerVectorStore 类，您需要提供 4 个必需的参数，其他参数是可选的，只有在与默认参数不同时才需要传递。
instance_id- Spanner 实例的名称database_id- Spanner 数据库的名称table_name- 数据库中用于存储文档及其嵌入的表的名称。embedding_service- 用于生成嵌入的嵌入实现。
db = SpannerVectorStore(
instance_id=INSTANCE,
database_id=DATABASE,
table_name=TABLE_NAME,
ignore_metadata_columns=[],
embedding_service=embeddings,
metadata_json_column="metadata",
)
🔐 添加文档
要在向量存储中添加文档。
import uuid
from langchain_community.document_loaders import HNLoader
loader = HNLoader("https://news.ycombinator.com/item?id=34817881")
documents = loader.load()
ids = [str(uuid.uuid4()) for _ in range(len(documents))]
🔐 搜索文档
要使用相似性搜索在向量存储中搜索文档。
db.similarity_search(query="Explain me vector store?", k=3)
🔐 搜索文档
要使用最大边际相关性搜索在向量存储中搜索文档。
db.max_marginal_relevance_search("Testing the langchain integration with spanner", k=3)
🔐 删除文档
要从向量存储中删除文档，请使用与初始化 VectorStore 时 row_id`` 列中的值相对应的 ID。
db.delete(ids=["id1", "id2"])
🔐 删除文档
要从向量存储中删除文档，您可以利用文档本身。将在初始化 VectorStore 时提供的 content 列和 metadata 列将用于找出与文档相对应的行。然后将删除任何匹配的行。
db.delete(documents=[documents[0], documents[1]])