跳到主要内容
Databricks 向量搜索是一个无服务器相似性搜索引擎,允许您在向量数据库中存储数据的向量表示,包括元数据。通过向量搜索,您可以从 Unity Catalog 管理的 Delta 表创建自动更新的向量搜索索引,并通过简单的 API 查询它们以返回最相似的向量。 本 notebook 展示了如何将 LangChain 与 Databricks 向量搜索结合使用。

设置

要访问 Databricks 模型,您需要创建一个 Databricks 帐户,设置凭据(仅当您在 Databricks 工作区之外时),并安装所需的包。

凭证(仅当您在 Databricks 外部时)

如果您在 Databricks 内部运行 LangChain 应用程序,则可以跳过此步骤。 否则,您需要手动将 Databricks 工作区主机名和个人访问令牌分别设置为 DATABRICKS_HOSTDATABRICKS_TOKEN 环境变量。有关如何获取访问令牌,请参阅身份验证文档
import getpass
import os

os.environ["DATABRICKS_HOST"] = "https://your-databricks-workspace"
if "DATABRICKS_TOKEN" not in os.environ:
    os.environ["DATABRICKS_TOKEN"] = getpass.getpass(
        "Enter your Databricks access token: "
    )

安装

LangChain Databricks 集成位于 databricks-langchain 包中。
pip install -qU databricks-langchain

创建向量搜索端点和索引(如果尚未创建)

在本节中,我们将使用客户端 SDK 创建一个 Databricks 向量搜索端点和索引。 如果您已经拥有端点和索引,则可以跳过本节,直接进入“实例化”一节。 首先,实例化 Databricks VectorSearch 客户端:
from databricks.vector_search.client import VectorSearchClient

client = VectorSearchClient()
接下来,我们将创建一个新的 VectorSearch 端点。
endpoint_name = "<your-endpoint-name>"

client.create_endpoint(name=endpoint_name, endpoint_type="STANDARD")
最后,我们将创建一个可在端点上查询的索引。Databricks 向量搜索中有两种类型的索引,DatabricksVectorSearch 类支持这两种用例。
  • Delta 同步索引自动与源 Delta 表同步,当 Delta 表中的基础数据发生变化时,会自动增量更新索引。
  • 直接向量访问索引支持直接读写向量和元数据。用户负责使用 REST API 或 Python SDK 更新此表。
此外,对于 delta-sync 索引,您可以选择使用 Databricks 管理的嵌入或自管理嵌入(通过 LangChain 嵌入类)。 以下代码创建一个直接访问索引。请参阅 Databricks 文档,了解创建其他类型索引的说明。
index_name = "<your-index-name>"  # Format: "<catalog>.<schema>.<index-name>"

index = client.create_direct_access_index(
    endpoint_name=endpoint_name,
    index_name=index_name,
    primary_key="id",
    # Dimension of the embeddings. Please change according to the embedding model you are using.
    embedding_dimension=3072,
    # A column to store the embedding vectors for the text data
    embedding_vector_column="text_vector",
    schema={
        "id": "string",
        "text": "string",
        "text_vector": "array<float>",
        # Optional metadata columns
        "source": "string",
    },
)

index.describe()

实例化

DatabricksVectorSearch 的实例化根据您的索引是使用 Databricks 管理的嵌入还是自管理嵌入(即您选择的 LangChain 嵌入对象)而略有不同。 如果您正在使用带有 Databricks 管理的嵌入的 delta-sync 索引:
from databricks_langchain import DatabricksVectorSearch

vector_store = DatabricksVectorSearch(
    endpoint=endpoint_name,
    index_name=index_name,
)
如果您正在使用直接访问索引或带有自管理嵌入的 delta-sync 索引,您还需要提供嵌入模型和源表中用于嵌入的文本列
# | output: false
# | echo: false
from langchain_openai import OpenAIEmbeddings

embeddings = OpenAIEmbeddings(model="text-embedding-3-large")
vector_store = DatabricksVectorSearch(
    endpoint=endpoint_name,
    index_name=index_name,
    embedding=embeddings,
    # The column name in the index that contains the text data to be embedded
    text_column="document_content",
)

管理向量存储

向向量存储添加项目

注意:通过 add_documents 方法将项目添加到向量存储仅支持直接访问索引。
from langchain_core.documents import Document

document_1 = Document(page_content="foo", metadata={"source": "https://example.com"})

document_2 = Document(page_content="bar", metadata={"source": "https://example.com"})

document_3 = Document(page_content="baz", metadata={"source": "https://example.com"})

documents = [document_1, document_2, document_3]

vector_store.add_documents(documents=documents, ids=["1", "2", "3"])
['1', '2', '3']

从向量存储中删除项目

注意:通过 delete 方法从向量存储中删除项目仅支持直接访问索引。
vector_store.delete(ids=["3"])
True

查询向量存储

一旦您的向量存储被创建并添加了相关文档,您很可能希望在链或代理运行期间查询它。

直接查询

执行简单的相似性搜索可以按如下方式完成
results = vector_store.similarity_search(
    query="thud", k=1, filter={"source": "https://example.com"}
)
for doc in results:
    print(f"* {doc.page_content} [{doc.metadata}]")
* foo [{'id': '1'}]
注意:默认情况下,相似性搜索仅返回主键和文本列。如果您想检索与文档相关的自定义元数据,请在初始化向量存储时在 columns 参数中传递附加列。
vector_store = DatabricksVectorSearch(
    endpoint=endpoint_name,
    index_name=index_name,
    embedding=embeddings,
    text_column="text",
    columns=["source"],
)

results = vector_store.similarity_search(query="thud", k=1)
for doc in results:
    print(f"* {doc.page_content} [{doc.metadata}]")
* foo [{'source': 'https://example.com', 'id': '1'}]
如果您想执行相似性搜索并接收相应的分数,可以运行
results = vector_store.similarity_search_with_score(
    query="thud", k=1, filter={"source": "https://example.com"}
)
for doc, score in results:
    print(f"* [SIM={score:3f}] {doc.page_content} [{doc.metadata}]")
* [SIM=0.414035] foo [{'source': 'https://example.com', 'id': '1'}]

通过转换为检索器进行查询

您还可以将向量存储转换为检索器,以便在您的链中更轻松地使用。
retriever = vector_store.as_retriever(search_type="mmr", search_kwargs={"k": 1})
retriever.invoke("thud")
[Document(metadata={'source': 'https://example.com', 'id': '1'}, page_content='foo')]

用于检索增强生成的使用

有关如何将此向量存储用于检索增强生成 (RAG) 的指南,请参阅以下部分

API 参考

有关所有 DatabricksVectorSearch 功能和配置的详细文档,请参阅 API 参考:api-docs.databricks.com/python/databricks-ai-bridge/latest/databricks_langchain.html#databricks_langchain.DatabricksVectorSearch
以编程方式连接这些文档到 Claude、VSCode 等,通过 MCP 获取实时答案。
© . This site is unofficial and not affiliated with LangChain, Inc.