Redis

本节将指导您完成设置以存储文档嵌入并执行相似性搜索。RedisVectorStorespring-doc.cn

Redis 是一种开源（BSD 许可）内存中数据结构存储，用作数据库、缓存、消息代理和流式处理引擎。Redis 提供数据结构，例如字符串、哈希、列表、集、带有范围查询的排序集、位图、hyperloglog、地理空间索引和流。spring-doc.cn

Redis Search and Query 扩展了 Redis OSS 的核心功能，允许您将 Redis 作为矢量数据库使用：spring-doc.cn

先决条件

  1. Redis 堆栈实例spring-doc.cn

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

自动配置

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

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

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

dependencies {
    implementation 'org.springframework.ai:spring-ai-redis-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")));
}

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

spring.ai.vectorstore.redis.uri=<your redis instance uri>
spring.ai.vectorstore.redis.index=<your index name>
spring.ai.vectorstore.redis.prefix=<your prefix>

# API key if needed, e.g. OpenAI
spring.ai.openai.api.key=<api-key>

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

现在，您可以在应用程序中自动连接 Redis 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 to Redis
vectorStore.add(documents);

// Retrieve documents similar to a query
List<Document> results = this.vectorStore.similaritySearch(SearchRequest.query("Spring").withTopK(5));

配置属性

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

财产 描述 默认值

spring.ai.vectorstore.redis.urispring-doc.cn

服务器连接 URIspring-doc.cn

redis://localhost:6379spring-doc.cn

spring.ai.vectorstore.redis.indexspring-doc.cn

索引名称spring-doc.cn

default-indexspring-doc.cn

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

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

falsespring-doc.cn

spring.ai.vectorstore.redis.prefixspring-doc.cn

前缀spring-doc.cn

default:spring-doc.cn

元数据筛选

您还可以将通用的可移植元数据筛选器与 RedisVectorStore 结合使用。spring-doc.cn

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

vectorStore.similaritySearch(
   SearchRequest
      .query("The World")
      .withTopK(TOP_K)
      .withSimilarityThreshold(SIMILARITY_THRESHOLD)
      .withFilterExpression("country in ['UK', 'NL'] && year >= 2020"));

或者以编程方式使用表达式 DSL：spring-doc.cn

FilterExpressionBuilder b = new FilterExpressionBuilder();

vectorStore.similaritySearch(
   SearchRequest
      .query("The World")
      .withTopK(TOP_K)
      .withSimilarityThreshold(SIMILARITY_THRESHOLD)
      .withFilterExpression(b.and(
         b.in("country", "UK", "NL"),
         b.gte("year", 2020)).build()));

可移植的筛选表达式会自动转换为 Redis 搜索查询。 例如，以下可移植筛选条件表达式：spring-doc.cn

country in ['UK', 'NL'] && year >= 2020

转换为 Redis 查询：spring-doc.cn

@country:{UK | NL} @year:[2020 inf]

手动配置

如果您不想使用自动配置，则可以手动配置 Redis Vector Store。 添加 Redis Vector Store 和 Jedis 依赖项spring-doc.cn

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

<dependency>
    <groupId>redis.clients</groupId>
    <artifactId>jedis</artifactId>
    <version>5.1.0</version>
</dependency>
请参阅 Dependency Management 部分，将 Spring AI BOM 添加到您的构建文件中。

然后，在 Spring 配置中创建一个 bean：RedisVectorStorespring-doc.cn

@Bean
public VectorStore vectorStore(EmbeddingModel embeddingModel) {
  RedisVectorStoreConfig config = RedisVectorStoreConfig.builder()
     .withURI("redis://localhost:6379")
     // Define the metadata fields to be used
     // in the similarity search filters.
     .withMetadataFields(
        MetadataField.tag("country"),
        MetadataField.numeric("year"))
     .build();

  return new RedisVectorStore(config, embeddingModel);
}

创建 as bean 更方便，也是首选。 但是，如果您决定手动创建它，则必须在设置属性之后和使用 Client 端之前调用 。RedisVectorStoreRedisVectorStore#afterPropertiesSet()spring-doc.cn

您必须明确列出筛选条件表达式中使用的任何元数据字段的所有元数据字段名称和类型（、 或 ）。 上述寄存器可筛选的元数据字段： 类型 、 类型 。TAGTEXTNUMERICwithMetadataFieldscountryTAGyearNUMERICspring-doc.cn

然后在主代码中，创建一些文档：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("country", "UK", "year", 2020)),
   new Document("The World is Big and Salvation Lurks Around the Corner", Map.of()),
   new Document("You walk forward facing the past and you turn back toward the future.", Map.of("country", "NL", "year", 2023)));

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

vectorStore.add(documents);

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

List<Document> results = vectorStore.similaritySearch(
   SearchRequest
      .query("Spring")
      .withTopK(5));

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