ClickHouse

ClickHouse 是一个最快且最高效的开源数据库，适用于实时应用和分析，提供完整的 SQL 支持和各种函数来帮助用户编写分析查询。最近添加的数据结构和距离搜索函数（如 L2Distance）以及 近似最近邻搜索索引 使 ClickHouse 能够用作高性能和可扩展的向量数据库来存储和搜索具有 SQL 的向量。

此笔记本演示了如何使用与 ClickHouse 向量存储相关的功能。

设置

首先使用 docker 设置本地 clickhouse 服务器

! docker run -d -p 8123:8123 -p9000:9000 --name langchain-clickhouse-server --ulimit nofile=262144:262144 clickhouse/clickhouse-server:23.4.2.11

您需要安装 langchain-community 和 clickhouse-connect 才能使用此集成

pip install -qU langchain-community clickhouse-connect

凭据

此笔记本没有凭据，只需确保您已安装如上所示的软件包。

如果您希望获得一流的模型调用自动跟踪，还可以通过取消以下注释来设置您的 LangSmith API 密钥

# os.environ["LANGSMITH_API_KEY"] = getpass.getpass("Enter your LangSmith API key: ")
# os.environ["LANGSMITH_TRACING"] = "true"

实例化

OpenAI

pip install -qU langchain-openai

import getpass

    os.environ["OPENAI_API_KEY"] = getpass.getpass()

from langchain_openai import OpenAIEmbeddings

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

HuggingFace

pip install -qU langchain-huggingface

from langchain_huggingface import HuggingFaceEmbeddings

embeddings = HuggingFaceEmbeddings(model="sentence-transformers/all-mpnet-base-v2")

伪嵌入

pip install -qU langchain-core

from langchain_core.embeddings import FakeEmbeddings

embeddings = FakeEmbeddings(size=4096)

from langchain_community.vectorstores import Clickhouse, ClickhouseSettings

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

API 参考：Clickhouse | ClickhouseSettings

管理向量存储

创建向量存储后，我们可以通过添加和删除不同的项目与之交互。

将项目添加到向量存储

我们可以使用 add_documents 函数将项目添加到向量存储中。

from uuid import uuid4

from langchain_core.documents import Document

document_1 = Document(
    page_content="I had chocalate 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)

API 参考：Document

从向量存储中删除项目

我们可以使用 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:
    print(f"* {res.page_content} [{res.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}]")

其他搜索方法

此笔记本中未介绍各种其他搜索方法，例如 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) 的指南，请参阅以下部分

• 教程：使用外部知识
• 操作方法：使用 RAG 进行问答
• 检索概念文档

有关更多信息，请查看使用 Astra DB 的完整 RAG 模板 此处。

API 参考

有关所有 Clickhouse 功能和配置的详细文档，请访问 API 参考：https://python.langchain.ac.cn/api_reference/community/vectorstores/langchain_community.vectorstores.clickhouse.Clickhouse.html

相关

• 向量存储 概念指南
• 向量存储 操作指南