Redis

本节将引导您设置 `RedisVectorStore` 以存储文档嵌入并执行相似性搜索。

Redis 是一个开源（BSD 许可）、内存中的数据结构存储，用作数据库、缓存、消息代理和流引擎。Redis 提供诸如字符串、哈希、列表、集合、带范围查询的有序集合、位图、超日志、地理空间索引和流等数据结构。

Redis 搜索和查询扩展了 Redis OSS 的核心功能，并允许您将 Redis 用作向量数据库

将向量和关联的元数据存储在哈希或 JSON 文档中
检索向量
执行向量搜索

先决条件

一个 Redis Stack 实例
- Redis 云（推荐）
- Docker 镜像 `redis/redis-stack:latest`
`EmbeddingModel` 实例用于计算文档嵌入。有多种选择可用
- 如果需要，则为 EmbeddingModel 提供 API 密钥以生成 `RedisVectorStore` 存储的嵌入。

自动配置

Spring AI 为 Redis 向量存储提供 Spring Boot 自动配置。要启用它，请将以下依赖项添加到项目的 Maven `pom.xml` 文件

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

或您的 Gradle `build.gradle` 构建文件。

dependencies {
    implementation 'org.springframework.ai:spring-ai-redis-store-spring-boot-starter'
}

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

请参阅存储库部分，将里程碑和/或快照存储库添加到您的构建文件。

向量存储实现可以为您初始化必要的模式，但您必须通过在相应的构造函数中指定 `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(new OpenAiApi(System.getenv("SPRING_AI_OPENAI_API_KEY")));
}

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

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>

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

现在您可以自动装配应用程序中的 Redis 向量存储并使用它

@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.ai.vectorstore.redis.uri`	服务器连接 URI	`redis://127.0.0.1:6379`
`spring.ai.vectorstore.redis.index`	索引名称	`default-index`
`spring.ai.vectorstore.redis.initialize-schema`	是否初始化所需的模式	`false`
`spring.ai.vectorstore.redis.prefix`	前缀	`default`

spring.ai.vectorstore.redis.uri

服务器连接 URI

redis://127.0.0.1:6379

spring.ai.vectorstore.redis.index

索引名称

default-index

spring.ai.vectorstore.redis.initialize-schema

是否初始化所需的模式

false

spring.ai.vectorstore.redis.prefix

前缀

default

元数据过滤

您也可以将通用的、可移植的元数据过滤器与 RedisVectorStore 一起使用。

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

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

或使用表达式 DSL 以编程方式使用

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 搜索查询。例如，以下可移植过滤器表达式

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

被转换为 Redis 查询

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

手动配置

如果您不想使用自动配置，则可以手动配置 Redis 向量存储。添加 Redis 向量存储和 Jedis 依赖项

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

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

然后，在您的 Spring 配置中创建一个 `RedisVectorStore` bean

@Bean
public VectorStore vectorStore(EmbeddingModel embeddingModel) {
  RedisVectorStoreConfig config = RedisVectorStoreConfig.builder()
     .withURI("redis://127.0.0.1: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);
}

更方便且推荐的做法是将 `RedisVectorStore` 创建为 Bean。但是，如果您决定手动创建它，则必须在设置属性之后和使用客户端之前调用 `RedisVectorStore#afterPropertiesSet()`。

您必须显式列出用于过滤器表达式中任何元数据字段的所有元数据字段名称和类型（`TAG`、`TEXT` 或 `NUMERIC`）。上面的 `withMetadataFields` 注册可过滤的元数据字段：类型为 `TAG` 的 `country`，类型为 `NUMERIC` 的 `year`。

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

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

现在将文档添加到您的向量存储中

vectorStore.add(documents);

最后，检索与查询相似的文档

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

如果一切顺利，您应该检索包含文本“Spring AI rocks!!”的文档。