Chroma

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

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

先决条件

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

  2. EmbeddingModel 实例来计算文档嵌入。有多种选择

    • 如果需要，用于 EmbeddingModel 生成 ChromaVectorStore 存储的嵌入的 API 密钥。

在启动时，如果尚未设置所需集合，ChromaVectorStore 会创建该集合。

自动配置

Spring AI 为 Chroma Vector Store 提供 Spring Boot 自动配置。要启用它，请将以下依赖项添加到项目的 Maven pom.xml 文件

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

或添加到 Gradle build.gradle 构建文件中。

dependencies {
    implementation 'org.springframework.ai:spring-ai-chroma-store-spring-boot-starter'
}
请参阅 依赖项管理 部分，将 Spring AI BOM 添加到构建文件中。
请参阅 存储库 部分，将里程碑和/或快照存储库添加到构建文件中。

向量存储实现可以为您初始化必要的架构，但您必须通过在适当的构造函数中指定 initializeSchema 布尔值或在 application.properties 文件中设置 …​initialize-schema=true 来选择加入。

这是一个重大更改！在早期版本的 Spring AI 中，此架构初始化默认发生。

此外，您还需要一个已配置的 EmbeddingModel bean。有关更多信息，请参阅 EmbeddingModel 部分。

以下是所需 bean 的示例

@Bean
public EmbeddingModel embeddingModel() {
    // Can be any other EmbeddingModel implementation.
    return new OpenAiEmbeddingModel(new OpenAiApi(System.getenv("SPRING_AI_OPENAI_API_KEY")));
}

要连接到 Chroma，您需要提供实例的访问详细信息。可以通过 Spring Boot 的 application.properties 提供一个简单配置，

# Chroma Vector Store connection properties
spring.ai.vectorstore.chroma.client.initialize-schema=<true or false>
spring.ai.vectorstore.chroma.client.host=<your Chroma instance host>
spring.ai.vectorstore.chroma.client.port=<your Chroma instance port>
spring.ai.vectorstore.chroma.client.key-token=<your access token (if configure)>
spring.ai.vectorstore.chroma.client.username=<your username (if configure)>
spring.ai.vectorstore.chroma.client.password=<your password (if configure)>

# Chroma Vector Store collection properties
spring.ai.vectorstore.chroma.store.collection-name=<your collection name>

# Chroma Vector Store configuration properties

# OpenAI API key if the OpenAI auto-configuration is used.
spring.ai.openai.api.key=<OpenAI Api-key>

请查看 配置参数 列表，了解向量存储的默认值和配置选项。

现在，您可以在应用程序中自动连接 Chroma 向量存储并使用它

@Autowired VectorStore vectorStore;

// ...

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")));

// Add the documents
vectorStore.add(List.of(document));

// Retrieve documents similar to a query
List<Document> results = vectorStore.similaritySearch(SearchRequest.query("Spring").withTopK(5));

配置属性

您可以在 Spring Boot 配置中使用以下属性来自定义向量存储。

属性 说明 默认值

spring.ai.vectorstore.chroma.client.host

服务器连接主机

localhost

spring.ai.vectorstore.chroma.client.port

服务器连接端口

8000

spring.ai.vectorstore.chroma.client.key-token

访问令牌（如果已配置）

-

spring.ai.vectorstore.chroma.client.username

访问用户名（如果已配置）

-

spring.ai.vectorstore.chroma.client.password

访问密码（如果已配置）

-

spring.ai.vectorstore.chroma.store.collection-name

集合名称

SpringAiCollection

对于使用 静态 API 令牌身份验证 保护的 ChromaDB，请使用 ChromaApi#withKeyToken(<Your Token Credentials>) 方法设置您的凭据。查看 ChromaWhereIT 了解示例。

对于使用 基本身份验证 保护的 ChromaDB，请使用 ChromaApi#withBasicAuth(<your user>, <your password>) 方法设置您的凭据。查看 BasicAuthChromaWhereIT 了解示例。

元数据筛选

您还可以将通用的可移植元数据筛选器与 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 筛选表达式。

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

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

会转换为专有的 Chroma 格式

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

手动配置

如果您希望手动配置 Chroma Vector Store，可以在 Spring Boot 应用程序中创建一个 ChromaVectorStore bean。

将这些依赖项添加到您的项目：* Chroma VectorStore。

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

  • OpenAI：计算嵌入时需要。您可以使用任何其他嵌入模型实现。

<dependency>
 <groupId>org.springframework.ai</groupId>
 <artifactId>spring-ai-openai-spring-boot-starter</artifactId>
</dependency>
请参阅 依赖项管理 部分，将 Spring AI BOM 添加到构建文件中。

示例代码

使用适当的 ChromaDB 授权配置创建一个 RestTemplate 实例，并使用它创建一个 ChromaApi 实例

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

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

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

@Bean
public VectorStore chromaVectorStore(EmbeddingModel embeddingModel, ChromaApi chromaApi) {
 return new ChromaVectorStore(embeddingModel, 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!!”的文档。

在本地运行 Chroma

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

在 localhost:8000/api/v1 启动一个色度存储