Skip to main content
Open In ColabOpen on GitHub

Google Spanner

Spanner is a highly scalable database that combines unlimited scalability with relational semantics, such as secondary indexes, strong consistency, schemas, and SQL providing 99.999% availability in one easy solution.

本笔记本介绍了如何将 Spanner 与 SpannerVectorStore 类一起用于向量搜索。

在 GitHub 上了解更多关于该包的信息。

Open In Colab

开始之前​

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

🦜🔗 库安装​

该集成位于其独立的 langchain-google-spanner 包中，因此我们需要安装它。

%pip install --upgrade --quiet langchain-google-spanner langchain-google-vertexai
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}
%env GOOGLE_CLOUD_PROJECT={PROJECT_ID}

💡 API 启用​

langchain-google-spanner 软件包要求您在 Google Cloud 项目中启用 Spanner API。

# 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,
    # Customize the table creation
    # id_column="row_id",
    # content_column="content_column",
    # 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 嵌入模型。 如果要使用 VertexAIEmbeddings，可能需要启用 Vertex AI API。我们建议在生产环境中设置嵌入模型的版本，请了解更多关于 文本嵌入模型 的信息。

# 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
)
API 参考：VertexAIEmbeddings

SpannerVectorStore​

要初始化 SpannerVectorStore 类，您需要提供 4 个必需参数，其他参数是可选的，只有在与默认值不同时才需要传递。

  1. instance_id - Spanner 实例的名称
  2. database_id - Spanner 数据库的名称
  3. table_name - 数据库中用于存储文档及其嵌入的表的名称。
  4. embedding_service - 用于生成嵌入的实现。
db = SpannerVectorStore(
    instance_id=INSTANCE,
    database_id=DATABASE,
    table_name=TABLE_NAME,
    embedding_service=embeddings,
    # Connect to a custom vector store table
    # id_column="row_id",
    # content_column="content",
    # metadata_columns=["metadata", "title"],
)

添加文档​

将文档添加到向量存储中。

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.add_documents(documents, ids)
API 参考：HNLoader

搜索文档​

在向量存储中使用相似性搜索来查找文档。

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 时提供的内容列和元数据列将用于找出与文档对应的行。任何匹配的行随后将被删除。

db.delete(documents=[documents[0], documents[1]])