Skip to main content
ClickHouse 是速度最快、资源效率最高的开源数据库，专为实时应用和分析而设计，支持完整的 SQL 语法及丰富的分析查询函数。近期新增的数据结构和距离搜索函数（如 L2Distance）以及近似最近邻搜索索引，使 ClickHouse 能够作为高性能、可扩展的向量数据库，通过 SQL 存储和搜索向量。
本 notebook 展示如何使用与 ClickHouse 向量存储相关的功能。

​
设置

首先使用 Docker 启动本地 ClickHouse 服务器： 
! docker run -d -p 8123:8123 -p 9000:9000 --name langchain-clickhouse-server --ulimit nofile=262144:262144 -e CLICKHOUSE_SKIP_USER_SETUP=1 clickhouse/clickhouse-server:25.7
使用此集成需要安装 langchain-community 和 clickhouse-connect： 
pip install -qU langchain-community clickhouse-connect

​
凭证

本 notebook 无需凭证，只需确保已按上述方式安装好依赖包。 如果您希望获得模型调用的顶级自动追踪功能，还可以取消注释以下内容，设置您的 LangSmith API 密钥： 
os.environ["LANGSMITH_API_KEY"] = getpass.getpass("Enter your LangSmith API key: ")
os.environ["LANGSMITH_TRACING"] = "true"

​
实例化

# | output: false
# | echo: false
from langchain_openai import OpenAIEmbeddings

embeddings = OpenAIEmbeddings(model="text-embedding-3-large")

from langchain_community.vectorstores import Clickhouse, ClickhouseSettings

settings = ClickhouseSettings(table="clickhouse_example")
vector_store = Clickhouse(embeddings, config=settings)

​
管理向量存储

创建向量存储后，可以通过添加和删除不同的条目与其进行交互。

​
向向量存储添加条目

可以使用 add_documents 函数向向量存储添加条目。 
from uuid import uuid4

from langchain_core.documents import Document

document_1 = Document(
    page_content="I had chocolate chip pancakes and scrambled eggs for breakfast this morning.",
    metadata={"source": "tweet"},
)

document_2 = Document(
    page_content="The weather forecast for tomorrow is cloudy and overcast, with a high of 62 degrees.",
    metadata={"source": "news"},
)

document_3 = Document(
    page_content="Building an exciting new project with LangChain - come check it out!",
    metadata={"source": "tweet"},
)

document_4 = Document(
    page_content="Robbers broke into the city bank and stole $1 million in cash.",
    metadata={"source": "news"},
)

document_5 = Document(
    page_content="Wow! That was an amazing movie. I can't wait to see it again.",
    metadata={"source": "tweet"},
)

document_6 = Document(
    page_content="Is the new iPhone worth the price? Read this review to find out.",
    metadata={"source": "website"},
)

document_7 = Document(
    page_content="The top 10 soccer players in the world right now.",
    metadata={"source": "website"},
)

document_8 = Document(
    page_content="LangGraph is the best framework for building stateful, agentic applications!",
    metadata={"source": "tweet"},
)

document_9 = Document(
    page_content="The stock market is down 500 points today due to fears of a recession.",
    metadata={"source": "news"},
)

document_10 = Document(
    page_content="I have a bad feeling I am going to get deleted :(",
    metadata={"source": "tweet"},
)

documents = [
    document_1,
    document_2,
    document_3,
    document_4,
    document_5,
    document_6,
    document_7,
    document_8,
    document_9,
    document_10,
]
uuids = [str(uuid4()) for _ in range(len(documents))]

vector_store.add_documents(documents=documents, ids=uuids)

​
从向量存储删除条目

可以使用 delete 函数通过 ID 删除向量存储中的条目。 
vector_store.delete(ids=uuids[-1])

​
查询向量存储

创建向量存储并添加相关文档后，通常需要在运行链或智能体时对其进行查询。

​
直接查询

​
相似度搜索

执行简单相似度搜索的方法如下： 
results = vector_store.similarity_search(
    "LangChain provides abstractions to make working with LLMs easy", k=2
)
for res in results:
    page_content, metadata = res
    print(f"* {page_content} [{metadata}]")

​
带分数的相似度搜索

也可以带分数进行搜索： 
results = vector_store.similarity_search_with_score("Will it be hot tomorrow?", k=1)
for res, score in results:
    print(f"* [SIM={score:3f}] {res.page_content} [{res.metadata}]")

​
过滤

您可以直接使用 ClickHouse SQL 的 WHERE 子句。可以按照标准 SQL 编写 WHERE 子句。 注意：请注意 SQL 注入风险，此接口不得直接由终端用户调用。 如果您在设置中自定义了 column_map，可以像这样使用过滤器进行搜索： 
meta = vector_store.metadata_column
results = vector_store.similarity_search_with_relevance_scores(
    "What did I eat for breakfast?",
    k=4,
    where_str=f"{meta}.source = 'tweet'",
)
for res in results:
    print(f"* {res.page_content} [{res.metadata}]")

​
其他搜索方法

还有多种其他搜索方法未在本 notebook 中介绍，例如 MMR 搜索或按向量搜索。有关 Clickhouse 向量存储可用搜索能力的完整列表，请查阅 API 参考。

​
转换为检索器进行查询

您还可以将向量存储转换为检索器，以便在链中更方便地使用。 以下是将向量存储转换为检索器，然后使用简单查询和过滤器调用检索器的方法： 
retriever = vector_store.as_retriever(
    search_type="similarity_score_threshold",
    search_kwargs={"k": 1, "score_threshold": 0.5},
)
retriever.invoke("Stealing from the bank is a crime", filter={"source": "news"})

​
用于检索增强生成

有关如何将此向量存储用于检索增强生成（RAG）的指南，请参阅以下章节： 更多内容，请查阅使用 Astra DB 的完整 RAG 模板 这里。

​
API 参考

有关 Clickhouse 所有功能和配置的详细文档，请前往 API 参考。
在 GitHub 上编辑此页面 或 提交问题。
通过 MCP 将这些文档连接 到 Claude、VSCode 等，获取实时解答。