Chroma

  • 配置 ChromaVectorStore，包括设置 OpenAI API 密钥。

  • 将必要的依赖项添加到项目中。

  • 使用示例代码创建文档、将其添加到向量存储并检索与查询相似的文档。

  • 利用通用和可移植的元数据过滤器。

  • 在本地运行 ChromaDB。

本节将指导您设置 Chroma VectorStore 以存储文档嵌入并执行相似性搜索。 Chroma Container

What is Chroma?

Chroma 是开源嵌入数据库。它为您提供了存储文档嵌入、内容和元数据以及搜索这些嵌入（包括元数据过滤）的工具。

Prerequisites

  1. OpenAI 帐户：在 OpenAI Signup上创建一个帐户并生成 API Keys上的令牌。

  2. 访问 ChromeDB。setup local ChromaDB 附录显示了如何使用 Docker 容器在本地设置数据库。

在启动时，ChromaVectorStore 会在尚未配置的情况下创建必要的集合。

Configuration

要设置 ChromaVectorStore，你需要提供你的 OpenAI API 密钥。可以像这样将其设置为环境变量：

export SPRING_AI_OPENAI_API_KEY='Your_OpenAI_API_Key'

Dependencies

将这些依赖项添加到你的项目中：

  • OpenAI：用于计算嵌入。

<dependency>
 <groupId>org.springframework.ai</groupId>
 <artifactId>spring-ai-openai-spring-boot-starter</artifactId>
</dependency>

  • Chroma VectorStore.

<dependency>
  <groupId>org.springframework.ai</groupId>
  <artifactId>spring-ai-chroma-store</artifactId>
</dependency>

  1. 参见 Dependency Management 部分，将 Spring AI BOM 添加到你的构建文件中。

Sample Code

使用正确的 ChromaDB 授权配置创建一个 RestTemplate 实例，然后使用它创建一个 ChromaApi 实例：

@Bean
public RestTemplate restTemplate() {
   return new RestTemplate();
}

@Bean
public ChromaApi chromaApi(RestTemplate restTemplate) {
   String chromaUrl = "http://localhost:8000";
   ChromaApi chromaApi = new ChromaApi(chromaUrl, restTemplate);
   return chromaApi;
}

对于使用 Static API Token Authentication 保护的 ChromaDB，使用 ChromaApi#withKeyToken(<Your Token Credentials>) 方法设置您的凭据。查看 ChromaWhereIT 以获取示例。 对于使用 Basic Authentication 保护的 ChromaDB，使用 ChromaApi#withBasicAuth(<your user>, <your password>) 方法设置您的凭据。查看 BasicAuthChromaWhereIT 以获取示例。

通过将 Spring Boot OpenAI 启动器添加到你的项目中，与 OpenAI 的嵌入集成。这为你提供了嵌入客户端的实现：

@Bean
public VectorStore chromaVectorStore(EmbeddingClient embeddingClient, ChromaApi chromaApi) {
 return new ChromaVectorStore(embeddingClient, chromaApi, "TestCollection");
}

在你的主代码中，创建一些文档：

List<Document> documents = List.of(
 new Document("Spring AI rocks!! Spring AI rocks!! Spring AI rocks!! Spring AI rocks!! Spring AI rocks!!", Map.of("meta1", "meta1")),
 new Document("The World is Big and Salvation Lurks Around the Corner"),
 new Document("You walk forward facing the past and you turn back toward the future.", Map.of("meta2", "meta2")));

将文档添加到你的向量存储：

vectorStore.add(documents);

最后，检索与查询类似的文档：

List<Document> results = vectorStore.similaritySearch("Spring");

如果一切都顺利，你应该检索包含文本 “Spring AI rocks!!” 的文档。

Metadata filtering

您也可以将通用便携式 metadata filters 与 ChromaVector 存储一起使用。

例如，你可以使用文本表达式语言：

vectorStore.similaritySearch(
                    SearchRequest.defaults()
                            .withQuery("The World")
                            .withTopK(TOP_K)
                            .withSimilarityThreshold(SIMILARITY_THRESHOLD)
                            .withFilterExpression("author in ['john', 'jill'] && article_type == 'blog'"));

或使用 Filter.Expression DSL 以编程方式：

FilterExpressionBuilder b = new FilterExpressionBuilder();

vectorStore.similaritySearch(SearchRequest.defaults()
                    .withQuery("The World")
                    .withTopK(TOP_K)
                    .withSimilarityThreshold(SIMILARITY_THRESHOLD)
                    .withFilterExpression(b.and(
                            b.in("john", "jill"),
                            b.eq("article_type", "blog")).build()));

这些（可移植）筛选表达式将自动转换为专有 Chroma where filter expressions。

例如，此可移植的筛选器表达式：

author in ['john', 'jill'] && article_type == 'blog'

转换为专有 Chroma 格式

{"$and":[
	{"author": {"$in": ["john", "jill"]}},
	{"article_type":{"$eq":"blog"}}]
}

Run Chroma Locally

docker run -it --rm --name chroma -p 8000:8000 ghcr.io/chroma-core/chroma:0.4.15

使用 [role="bare"][role="bare"]http://localhost:8000/api/v1 启动一个 Chroma 存储。