此版本仍在开发中，尚不被认为是稳定的。对于最新的快照版本，请使用 Spring AI 1.0.1！spring-doc.cadn.net.cn

Chroma

本节将引导您设置Chroma VectorStore来存储文档嵌入并执行相似性搜索。spring-doc.cadn.net.cn

Chroma 是开源嵌入数据库。它为您提供了存储文档嵌入、内容和元数据以及搜索这些嵌入的工具，包括元数据筛选。spring-doc.cadn.net.cn

前提条件

  1. 访问 ChromaDB。兼容 Chroma Cloud，或设置本地 ChromaDB 在附录中展示了如何使用 Docker 容器在本地设置数据库。spring-doc.cadn.net.cn

    • 对于 Chroma Cloud：您需要 Chroma Cloud 仪表板中的 API 密钥、租户名称和数据库名称。spring-doc.cadn.net.cn

    • 对于本地 ChromaDB：除了启动容器外，无需其他配置。spring-doc.cadn.net.cn

  2. EmbeddingModel实例来计算文档嵌入。有几个选项可用：spring-doc.cadn.net.cn

启动时，ChromaVectorStore创建所需的集合（如果尚未预配）。spring-doc.cadn.net.cn

自动配置

Spring AI 自动配置、入门模块的工件名称发生了重大变化。 有关更多信息，请参阅升级说明。spring-doc.cadn.net.cn

Spring AI 为 Chroma Vector Store 提供 Spring Boot 自动配置。 要启用它，请将以下依赖项添加到项目的 Mavenpom.xml文件：spring-doc.cadn.net.cn

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

或 Gradlebuild.gradle构建文件。spring-doc.cadn.net.cn

dependencies {
    implementation 'org.springframework.ai:spring-ai-starter-vector-store-chroma'
}
请参阅依赖项管理部分，将 Spring AI BOM 添加到构建文件中。
请参阅 Artifact Repositories 部分，将 Maven Central 和/或 Snapshot Repositories 添加到构建文件中。

矢量存储实现可以为您初始化必要的架构，但您必须通过指定initializeSchema布尔值或通过…​initialize-schema=true在application.properties文件。spring-doc.cadn.net.cn

这是一个重大变化！在早期版本的 Spring AI 中，默认情况下会发生此模式初始化。

此外，您还需要配置一个EmbeddingModel豆。有关详细信息，请参阅 EmbeddingModel 部分。spring-doc.cadn.net.cn

下面是所需 bean 的示例：spring-doc.cadn.net.cn

@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 提供简单的配置，spring-doc.cadn.net.cn

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

请查看矢量存储的配置参数列表，了解默认值和配置选项。spring-doc.cadn.net.cn

现在，您可以在应用程序中自动连接 Chroma 矢量存储并使用它spring-doc.cadn.net.cn

@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-doc.cadn.net.cn

属性 描述 默认值

spring.ai.vectorstore.chroma.client.hostspring-doc.cadn.net.cn

服务器连接主机spring-doc.cadn.net.cn

http://localhostspring-doc.cadn.net.cn

spring.ai.vectorstore.chroma.client.portspring-doc.cadn.net.cn

服务器连接端口spring-doc.cadn.net.cn

8000spring-doc.cadn.net.cn

spring.ai.vectorstore.chroma.client.key-tokenspring-doc.cadn.net.cn

访问Tokens（如果已配置）spring-doc.cadn.net.cn

-spring-doc.cadn.net.cn

spring.ai.vectorstore.chroma.client.usernamespring-doc.cadn.net.cn

访问用户名（如果已配置）spring-doc.cadn.net.cn

-spring-doc.cadn.net.cn

spring.ai.vectorstore.chroma.client.passwordspring-doc.cadn.net.cn

访问密码（如果已配置）spring-doc.cadn.net.cn

-spring-doc.cadn.net.cn

spring.ai.vectorstore.chroma.tenant-namespring-doc.cadn.net.cn

租户（Chroma Cloud 需要）spring-doc.cadn.net.cn

SpringAiTenantspring-doc.cadn.net.cn

spring.ai.vectorstore.chroma.database-namespring-doc.cadn.net.cn

数据库名称（Chroma Cloud 必填）spring-doc.cadn.net.cn

SpringAiDatabasespring-doc.cadn.net.cn

spring.ai.vectorstore.chroma.collection-namespring-doc.cadn.net.cn

集合名称spring-doc.cadn.net.cn

SpringAiCollectionspring-doc.cadn.net.cn

spring.ai.vectorstore.chroma.initialize-schemaspring-doc.cadn.net.cn

是否初始化所需的架构（如果租户/数据库/集合不存在，则创建它们）spring-doc.cadn.net.cn

falsespring-doc.cadn.net.cn

对于使用静态 API Tokens身份验证保护的 ChromaDB，请使用ChromaApi#withKeyToken(<Your Token Credentials>)方法来设置您的凭据。检查ChromaWhereIT举个例子。spring-doc.cadn.net.cn

对于使用基本身份验证保护的 ChromaDB，请使用ChromaApi#withBasicAuth(<your user>, <your password>)方法来设置您的凭据。检查BasicAuthChromaWhereIT举个例子。spring-doc.cadn.net.cn

Chroma Cloud 配置

对于 Chroma Cloud，您需要提供 Chroma Cloud 实例中的租户和数据库名称。下面是一个示例配置：spring-doc.cadn.net.cn

# 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）- 您必须通过以下方式提供您的 API 密钥key-token- 租户和数据库名称必须与您的 Chroma Cloud 配置匹配 -设置initialize-schema=true自动创建集合（如果不存在）（它不会重新创建现有租户/数据库）spring-doc.cadn.net.cn

元数据过滤

您也可以将通用的、可移植的元数据过滤器与 ChromaVector 存储一起使用。spring-doc.cadn.net.cn

例如，您可以使用文本表达式语言：spring-doc.cadn.net.cn

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

或以编程方式使用Filter.ExpressionDSL：spring-doc.cadn.net.cn

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());
这些（可移植的）过滤器表达式会自动转换为专有的 Chromawhere 过滤表达式。

例如，这个可移植过滤器表达式：spring-doc.cadn.net.cn

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

转换为专有的 Chroma 格式spring-doc.cadn.net.cn

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

手动配置

如果你更喜欢手动配置Chroma矢量存储，可以通过创建一个ChromaVectorStorebean 在你的 Spring Boot 应用程序中。spring-doc.cadn.net.cn

将这些依赖项添加到您的项目中：* Chroma矢量存储。spring-doc.cadn.net.cn

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

示例代码

创建一个RestClient.Builder实例，并使用它来创建一个ChromaApi实例：spring-doc.cadn.net.cn

@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 Starters添加到您的项目中，与 OpenAI 的嵌入集成。这为您提供了嵌入客户端的实现：spring-doc.cadn.net.cn

@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();
}

在主代码中，创建一些文档：spring-doc.cadn.net.cn

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

将文档添加到矢量存储：spring-doc.cadn.net.cn

vectorStore.add(documents);

最后，检索类似于查询的文档：spring-doc.cadn.net.cn

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

如果一切顺利，您应该检索包含文本“Spring AI rocks！！”的文档。spring-doc.cadn.net.cn

在本地运行 Chroma

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

在 localhost：8000/api/v1 启动 chroma storespring-doc.cadn.net.cn