Chroma

本节将引导您完成 Chroma VectorStore 的设置，以存储文档嵌入并执行相似性搜索。 Chroma 是开源的嵌入式数据库。它为您提供了存储文档嵌入、内容和元数据以及搜索这些嵌入（包括元数据过滤）的工具。

先决条件

  1. 访问 ChromaDB。兼容 Chroma Cloud，或者附录中的 run Chroma Locally 展示了如何使用 Docker 容器在本地设置数据库。

    • 对于 Chroma Cloud：您需要从 Chroma Cloud 仪表板获取 API 密钥、租户名称和数据库名称。

    • 对于本地 ChromaDB：除了启动容器外，无需额外配置。

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

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

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

自动配置

Spring AI 自动配置、启动器模块的工件名称发生了重大变化。 请参阅 升级说明 获取更多信息。

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

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

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

dependencies {
    implementation 'org.springframework.ai:spring-ai-starter-vector-store-chroma'
}

请参阅 依赖管理 部分，将 Spring AI BOM 添加到您的构建文件中。

请参阅 工件仓库 部分，添加 Maven Central 和/或 Snapshot 仓库到您的构建文件中。

向量存储实现可以为您初始化所需的模式，但您必须通过在适当的构造函数中指定 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(OpenAiApi.builder().apiKey(System.getenv("OPENAI_API_KEY")).build());
}

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

# Chroma Vector Store connection properties
spring.ai.vectorstore.chroma.client.host=<your Chroma instance host>  // for Chroma Cloud: api.trychroma.com
spring.ai.vectorstore.chroma.client.port=<your Chroma instance port> // for Chroma Cloud: 443
spring.ai.vectorstore.chroma.client.key-token=<your access token (if configure)> // for Chroma Cloud: use the API key
spring.ai.vectorstore.chroma.client.username=<your username (if configure)>
spring.ai.vectorstore.chroma.client.password=<your password (if configure)>

# Chroma Vector Store tenant and database properties (required for Chroma Cloud)
spring.ai.vectorstore.chroma.tenant-name=<your tenant name> // default: SpringAiTenant
spring.ai.vectorstore.chroma.database-name=<your database name> // default: SpringAiDatabase

# 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>

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

现在您可以在应用程序中自动装配 Chroma Vector Store 并使用它

@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.builder().query("Spring").topK(5).build());

配置属性

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

属性 描述 默认值

spring.ai.vectorstore.chroma.client.host

服务器连接主机

http://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.tenant-name

租户（Chroma Cloud 必需）

SpringAiTenant

spring.ai.vectorstore.chroma.database-name

数据库名称（Chroma Cloud 必需）

SpringAiDatabase

spring.ai.vectorstore.chroma.collection-name

集合名称

SpringAiCollection

spring.ai.vectorstore.chroma.initialize-schema

是否初始化所需模式（如果不存在则创建租户/数据库/集合）

false

对于使用 静态 API 令牌认证 保护的 ChromaDB，请使用 ChromaApi#withKeyToken(<您的令牌凭据>) 方法设置您的凭据。请查看 ChromaWhereIT 获取示例。 对于使用 基本认证 保护的 ChromaDB，请使用 ChromaApi#withBasicAuth(<您的用户>, <您的密码>) 方法设置您的凭据。请查看 BasicAuthChromaWhereIT 获取示例。

Chroma Cloud 配置

对于 Chroma Cloud，您需要提供 Chroma Cloud 实例的租户和数据库名称。以下是配置示例：

# Chroma Cloud connection
spring.ai.vectorstore.chroma.client.host=api.trychroma.com
spring.ai.vectorstore.chroma.client.port=443
spring.ai.vectorstore.chroma.client.key-token=<your-chroma-cloud-api-key>

# Chroma Cloud tenant and database (required)
spring.ai.vectorstore.chroma.tenant-name=<your-tenant-id>
spring.ai.vectorstore.chroma.database-name=<your-database-name>

# Collection configuration
spring.ai.vectorstore.chroma.collection-name=my-collection
spring.ai.vectorstore.chroma.initialize-schema=true

对于 Chroma Cloud： - 主机应为 api.trychroma.com - 端口应为 443 (HTTPS) - 您必须通过 key-token 提供您的 API 密钥 - 租户和数据库名称必须与您的 Chroma Cloud 配置匹配 - 设置 initialize-schema=true 以便在集合不存在时自动创建（它不会重新创建现有租户/数据库）

元数据过滤

您还可以将通用的、可移植的 元数据过滤器 与 ChromaVector 存储一起使用。

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

vectorStore.similaritySearch(
                    SearchRequest.builder()
                            .query("The World")
                            .topK(TOP_K)
                            .similarityThreshold(SIMILARITY_THRESHOLD)
                            .filterExpression("author in ['john', 'jill'] && article_type == 'blog'").build());

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

FilterExpressionBuilder b = new FilterExpressionBuilder();

vectorStore.similaritySearch(SearchRequest.builder()
                    .query("The World")
                    .topK(TOP_K)
                    .similarityThreshold(SIMILARITY_THRESHOLD)
                    .filterExpression(b.and(
                            b.in("john", "jill"),
                            b.eq("article_type", "blog")).build()).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-starter-model-openai</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 = "http://localhost:8000";
   ChromaApi chromaApi = new ChromaApi(chromaUrl, restClientBuilder);
   return chromaApi;
}

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

@Bean
public VectorStore chromaVectorStore(EmbeddingModel embeddingModel, ChromaApi chromaApi) {
 return ChromaVectorStore.builder(chromaApi, embeddingModel)
    .tenantName("your-tenant-name") // default: SpringAiTenant
    .databaseName("your-database-name") // default: SpringAiDatabase
    .collectionName("TestCollection")
    .initializeSchema(true)
    .build();
}

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

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:1.0.0

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