Redis

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

What is Redis?

Redis 是开源（BSD 许可）内存数据结构存储，用作数据库、缓存、消息代理和流引擎。Redis 提供了数据结构，比如字符串、哈希、列表、集合、范围查询分类集合、位图、hyperloglog、地理空间索引和流。

What is Redis Vector Search?

Redis Search and Query扩展了 Redis OSS 的核心特性，允许您使用 Redis 作为向量数据库：

将向量和关联的元数据存储在哈希或 JSON 文档中
Retrieve vectors
Perform vector searches

Prerequisites

EmbeddingClient 实例计算文档嵌入。有几个选项可用：
- Transformers Embedding - 在本地环境中计算嵌入。遵循 ONNX Transformers 嵌入说明。
- `OpenAI Embedding`使用 OpenAI 嵌入端点。您需要在 OpenAI Signup上创建一个帐户，并在 API Keys生成 api-key 令牌。
- 你还可以使用 Azure OpenAI Embedding。
A Redis Stack instance[style="loweralpha"]
1. Redis Cloud (recommended)
2. Docker image redis/redis-stack:latest

Dependencies

将这些依赖项添加到你的项目中：

计算嵌入所需的嵌入客户端启动程序。
Transformers 嵌入（本地）并遵循 ONNX Transformers 嵌入说明。

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

或使用 OpenAI（云）

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

参见 Dependency Management 部分，将 Spring AI BOM 添加到你的构建文件中。

你需要提供你的 OpenAI API 密钥。将其设置为一个环境变量，如下所示：

export SPRING_AI_OPENAI_API_KEY='Your_OpenAI_API_Key'

添加 Redis 向量存储和 Jedis 依赖项

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

<dependency>
    <groupId>redis.clients</groupId>
    <artifactId>jedis</artifactId>
    <version>5.1.0</version>
</dependency>

参见 Dependency Management 部分，将 Spring AI BOM 添加到你的构建文件中。

Usage

创建一个连接到 Redis 数据库的 RedisVectorStore 实例：

@Bean
public VectorStore vectorStore(EmbeddingClient embeddingClient) {
  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, embeddingClient);
}

创建为 Bean 的 RedisVectorStore 更加方便且更受青睐。但如果您决定手动创建它，则必须在设置属性并使用客户端之前调用 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!!” 的文档。

Metadata filtering

您还可以利用 RedisVectorStore 的通用可移植过滤器 metadata filters。

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

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 search queries。例如，以下可移植筛选器表达式：

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

将转换成 Redis 查询：

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