Chroma

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

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

先决条件

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

  2. EmbeddingModel 实例用于计算文档嵌入。有多种选项可用。

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

启动时，如果尚未配置，ChromaVectorStore 将创建所需的集合。

自动配置

Spring AI 为 Chroma 向量存储提供 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.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.initialize-schema=<true or false>
spring.ai.vectorstore.chroma.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(documents);

// Retrieve documents similar to a query
List<Document> results = this.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.collection-name

集合名称

SpringAiCollection

spring.ai.vectorstore.chroma.initialize-schema

是否初始化所需的模式

false

对于使用 静态 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 向量数据库，您可以通过在 Spring Boot 应用程序中创建一个 ChromaVectorStore bean 来实现。

将以下依赖项添加到您的项目中：* Chroma 向量数据库。

<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 授权配置创建一个 RestClient.Builder 实例，并使用它创建一个 ChromaApi 实例。

@Bean
public RestClient.Builder builder() {
    return RestClient.builder().requestFactory(new SimpleClientHttpRequestFactory());
}


@Bean
public ChromaApi chromaApi(RestClient.Builder restClientBuilder) {
   String chromaUrl = "https://127.0.0.1:8000";
   ChromaApi chromaApi = new ChromaApi(chromaUrl, restClientBuilder);
   return chromaApi;
}

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

@Bean
public VectorStore chromaVectorStore(EmbeddingModel embeddingModel, ChromaApi chromaApi) {
 return new ChromaVectorStore(embeddingModel, chromaApi, "TestCollection", false);
}

在您的主代码中，创建一些文档。

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 启动 Chroma 数据库。