本笔记本介绍如何开始使用 Chroma 向量存储。

>Chroma 是一个 AI 原生的开源向量数据库，专注于开发者的工作效率和幸福感。Chroma 采用 Apache 2.0 许可证。查看完整文档请访问 Chroma at 此页面，并在此处查找 LangChain 集成的 API 参考 此页面.

安装

要访问 Chroma 向量存储，您需要安装 langchain-chroma 集成包。

pip install -qU "langchain-chroma>=0.1.2"

凭据

您可以使用 Chroma 向量存储，无需任何凭据，只需安装上述包即可！

如果您是 Chroma Cloud 用户，请设置您的 CHROMA_TENANT, CHROMA_DATABASE和 CHROMA_API_KEY 环境变量。

安装 chromadb 包时，您还可以访问 Chroma CLI，它可以为您设置这些。首先， 登录 通过 CLI，然后使用 connect 命令:

chroma db connect [db_name] --env-file

如果您想获得最佳的全自动追踪 LangSmith API 密钥并启用追踪：

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

初始化

基本初始化

以下示例展示如何为 Chroma 设置嵌入函数，然后配置本地持久化来存储向量数据。

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

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

本地运行（内存中）

您只需实例化一个 Chroma 实例，传入集合名称和嵌入提供者，即可获得一个在内存中运行的 Chroma 服务器：

from langchain_chroma import Chroma

vector_store = Chroma(
    collection_name="example_collection",
    embedding_function=embeddings,
)

如果您不需要数据持久化，这是一个很好的选项，可以在使用 LangChain 构建 AI 应用程序时进行实验。

本地运行（带数据持久化）

您可以提供 persist_directory 参数来保存跨程序多次运行的数据：

from langchain_chroma import Chroma

vector_store = Chroma(
    collection_name="example_collection",
    embedding_function=embeddings,
    persist_directory="./chroma_langchain_db",
)

连接到 Chroma 服务器

如果您有在本地运行的 Chroma 服务器，或者您已经 部署了 一个，您可以提供 host argument.

来连接它。例如，您可以用 chroma run来启动一个本地运行的 Chroma 服务器，然后用 host='localhost':

from langchain_chroma import Chroma

vector_store = Chroma(
    collection_name="example_collection",
    embedding_function=embeddings,
    host="localhost",
)

来连接。对于其他部署，您可以使用 port, ssl和 headers 用于自定义连接的参数。

Chroma 云

Chroma Cloud 用户也可以使用 LangChain 进行构建。请提供您的 Chroma 实例，并提供您的 Chroma Cloud API 密钥、租户和数据库名称：

from langchain_chroma import Chroma

vector_store = Chroma(
    collection_name="example_collection",
    embedding_function=embeddings,
    chroma_cloud_api_key=os.getenv("CHROMA_API_KEY"),
    tenant=os.getenv("CHROMA_TENANT"),
    database=os.getenv("CHROMA_DATABASE"),
)

从客户端初始化

您也可以从 Chroma 客户端进行初始化，如果您想更方便地访问底层数据库，这将特别有用。

本地运行（内存中）

client = chromadb.Client()

本地运行（支持数据持久化）

client = chromadb.PersistentClient(path="./chroma_langchain_db")

连接到 Chroma 服务器

例如，如果您正在本地运行 Chroma 服务器（使用 chroma run):

client = chromadb.HttpClient(host="localhost", port=8000, ssl=False)

Chroma 云

设置您的 CHROMA_API_KEY, CHROMA_TENANT和 CHROMA_DATABASE后，您可以简单地实例化：

client = chromadb.CloudClient()

访问您的 Chroma 数据库

collection = client.get_or_create_collection("collection_name")
collection.add(ids=["1", "2", "3"], documents=["a", "b", "c"])

创建 Chroma 向量存储

vector_store_from_client = Chroma(
    client=client,
    collection_name="collection_name",
    embedding_function=embeddings,
)

管理向量存储

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

向向量存储添加项目

我们可以通过使用 add_documents function.

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"},
    id=1,
)

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

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

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

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

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

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

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

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

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

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)

更新向量存储中的项目

现在我们已向向量存储添加了文档，我们可以使用 update_documents function.

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

updated_document_2 = Document(
    page_content="The weather forecast for tomorrow is sunny and warm, with a high of 82 degrees.",
    metadata={"source": "news"},
    id=2,
)

vector_store.update_document(document_id=uuids[0], document=updated_document_1)
# You can also update multiple documents at once
vector_store.update_documents(
    ids=uuids[:2], documents=[updated_document_1, updated_document_2]
)

从向量存储删除项目

我们也可以按如下方式从向量存储中删除项目：

vector_store.delete(ids=uuids[-1])

查询向量存储

创建向量存储并添加相关文档后，在链或代理运行期间，您很可能希望对其进行查询。

直接查询

相似性搜索

执行简单的相似性搜索可以按如下方式进行：

results = vector_store.similarity_search(
    "LangChain provides abstractions to make working with LLMs easy",
    k=2,
    filter={"source": "tweet"},
)
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, filter={"source": "news"}
)
for res, score in results:
    print(f"* [SIM={score:3f}] {res.page_content} [{res.metadata}]")

按向量搜索

您也可以按向量搜索：

results = vector_store.similarity_search_by_vector(
    embedding=embeddings.embed_query("I love green eggs and ham!"), k=1
)
for doc in results:
    print(f"* {doc.page_content} [{doc.metadata}]")

其他搜索方法

还有多种其他搜索方法未在本笔记本中介绍，例如 MMR 搜索。有关 Chroma 的完整搜索能力列表，请参阅 API 参考。

转换为检索器进行查询

您还可以将向量存储转换为检索器，以便在链中更方便地使用。如需了解更多关于不同搜索类型和可传递的参数，请访问 Chroma API 参考.

retriever = vector_store.as_retriever(
    search_type="mmr", search_kwargs={"k": 1, "fetch_k": 5}
)
retriever.invoke("Stealing from the bank is a crime", filter={"source": "news"})

用于检索增强生成

有关如何使用此向量存储进行检索增强生成（RAG）的指南，请参阅以下章节：

• - 检索文档
• - 使用 LangChain 构建 RAG 应用
• - 代理式 RAG

API 参考

有关所有 Chroma 向量存储功能和配置请参阅 API 参考。