Chroma

Chroma

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

Chroma 是开源的嵌入数据库。它为您提供了存储文档嵌入、内容及元数据的工具，并支持在这些嵌入中进行搜索，包括元数据过滤功能。

先决条件

1. 访问 ChromaDB。 本地设置 ChromaDB 附录展示了如何使用 Docker 容器在本地设置数据库。
2. 用于计算文档嵌入的 EmbeddingModel 实例。提供了多种选项：
   • 如需要，可为 EmbeddingModel 提供 API 密钥，以生成由 ChromaVectorStore 存储的嵌入。

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

自动配置

Spring AI 为 Chroma 向量存储提供了 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'
}

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

此外，您还需要一个配置好的 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>
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.builder().query("Spring").topK(5).build());

配置属性

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

元数据过滤（Metadata filtering）

您同样可以利用通用的、可移植的 元数据过滤器 与 Chroma 向量存储结合使用。

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

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

例如，这个便携式过滤表达式：

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

被转换为专有的 Chroma 格式

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

手动配置

若您倾向于手动配置 Chroma 向量存储，可以在 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>

示例代码

创建一个配置了 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)
    .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 太棒了！！” 文本的文档。

本地运行 Chroma

Chroma Container

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

Chroma 存储访问地址：http://localhost:8000/api/v1