Chroma

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

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

先决条件

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

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

启动时，如果尚未预置 COLLECTION，则会创建所需的集合。ChromaVectorStorespring-doc.cn

自动配置

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

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

或您的 Gradle 构建文件。build.gradlespring-doc.cn

dependencies {
    implementation 'org.springframework.ai:spring-ai-chroma-store-spring-boot-starter'
}
请参阅 Dependency Management 部分，将 Spring AI BOM 添加到您的构建文件中。
请参阅 Repositories 部分，将 Milestone 和/或 Snapshot Repositories 添加到您的构建文件中。

矢量存储实现可以为您初始化必要的架构，但您必须通过在相应的构造函数中指定布尔值或在文件中进行设置来选择加入。initializeSchema…​initialize-schema=trueapplication.propertiesspring-doc.cn

这是一个突破性的变化！在早期版本的 Spring AI 中，默认情况下会进行此架构初始化。

此外，您还需要一个已配置的 Bean。请参阅 EmbeddingModel 部分以了解更多信息。EmbeddingModelspring-doc.cn

以下是所需 bean 的示例：spring-doc.cn

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

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

请查看 vector store 的配置参数列表，了解默认值和配置选项。spring-doc.cn

现在，您可以在应用程序中自动连接 Chroma Vector Store 并使用它spring-doc.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.query("Spring").withTopK(5));

配置属性

您可以在 Spring Boot 配置中使用以下属性来自定义矢量存储。spring-doc.cn

财产 描述 默认值

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

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

http://localhostspring-doc.cn

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

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

8000spring-doc.cn

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

访问令牌（如果已配置）spring-doc.cn

-spring-doc.cn

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

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

-spring-doc.cn

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

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

-spring-doc.cn

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

集合名称spring-doc.cn

SpringAiCollectionspring-doc.cn

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

是否初始化所需的 schemaspring-doc.cn

falsespring-doc.cn

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

对于使用基本身份验证保护的 ChromaDB，请使用该方法设置您的凭证。查看示例。ChromaApi#withBasicAuth(<your user>, <your password>)BasicAuthChromaWhereITspring-doc.cn

元数据筛选

您还可以将通用的可移植元数据过滤器与 ChromaVector 存储结合使用。spring-doc.cn

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

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

或使用 DSL 以编程方式：Filter.Expressionspring-doc.cn

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

例如，此可移植筛选条件表达式：spring-doc.cn

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

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

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

手动配置

如果您希望手动配置 Chroma Vector Store，则可以通过在 Spring Boot 应用程序中创建一个 bean 来实现。ChromaVectorStorespring-doc.cn

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

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

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

<dependency>
 <groupId>org.springframework.ai</groupId>
 <artifactId>spring-ai-openai-spring-boot-starter</artifactId>
</dependency>
请参阅 Dependency Management 部分，将 Spring AI BOM 添加到您的构建文件中。

示例代码

使用适当的 ChromaDB 授权配置创建一个实例，并使用它来创建一个实例：RestClient.BuilderChromaApispring-doc.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 的嵌入集成。这为您提供了 Embeddings 客户端的实现：spring-doc.cn

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

在您的主代码中，创建一些文档：spring-doc.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")));

将文档添加到您的 vector 存储中：spring-doc.cn

vectorStore.add(documents);

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

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

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

在本地运行 Chroma

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

在 localhost：8000/api/v1 启动 chroma 存储spring-doc.cn